#include <IFrameTagManager.h>
Public Member Functions |
|
virtual int | GetTagCount ()=0 |
Get number of frame tags. |
|
virtual DWORD | GetTagID (int i)=0 |
Get ID for the i'th frame tag in the list of
frame tags. |
|
virtual TimeValue | GetTimeByID (DWORD id, BOOL relative)=0 |
Get the tag's time value. |
|
virtual void | SetTimeByID (DWORD id, TimeValue newTime, BOOL relative)=0 |
Set the tag's time value. |
|
virtual DWORD | GetLockIDByID (DWORD id)=0 |
get the tag this tag is locked to. |
|
virtual BOOL | SetLockIDByID (DWORD id, DWORD newLockID)=0 |
set the tag this tag is locked to. |
|
virtual MSTR | GetNameByID (DWORD id)=0 |
get the tag's name |
|
virtual void | SetNameByID (DWORD id, MSTR &newName)=0 |
set the tag's name |
|
virtual BOOL | GetScaleByID (DWORD id)=0 |
get whether to scale the tag's time when
time is scaled |
|
virtual void | SetScaleByID (DWORD id, BOOL newScale)=0 |
set whether to scale the tag's time when
time is scaled |
|
virtual int | FindItem (DWORD id)=0 |
get the index of the tag in the sorted tag
list. |
|
virtual int | FindItemByTime (TimeValue t)=0 |
finds the first tag in the sorted list, if
any, for the given absolute time value |
|
virtual DWORD | CreateNewTag (MCHAR *name, TimeValue t, DWORD lockID, BOOL scale)=0 |
creates a new tag. |
|
virtual void | DeleteTag (DWORD id)=0 |
deletes the specified tag |
|
virtual void | ResetFrameTags ()=0 |
deletes all the tags |
|
virtual BOOL | CheckForLoop (DWORD testID, DWORD id)=0 |
returns true if tag testID is dependent on
tag id |
virtual int GetTagCount | ( | ) | [pure virtual] |
Get number of frame tags.
virtual DWORD GetTagID | ( | int | i | ) | [pure virtual] |
Get ID for the i'th frame tag in the list of frame tags.
virtual TimeValue GetTimeByID | ( | DWORD | id, |
BOOL | relative | ||
) | [pure virtual] |
Get the tag's time value.
id | - The id of the tag to query |
relative | - if TRUE, time is relative to the tag this tag is locked to, if any. If false, or this tag is not locked to another tag, the time is absolute |
virtual void SetTimeByID | ( | DWORD | id, |
TimeValue | newTime, | ||
BOOL | relative | ||
) | [pure virtual] |
Set the tag's time value.
id | - The id of the tag to set |
newTime | - The new time value to set on the Tag |
relative | - if TRUE, time is relative to the tag this tag is locked to, if any. If false, or this tag is not locked to another tag, the time is absolute |
virtual DWORD GetLockIDByID | ( | DWORD | id | ) | [pure virtual] |
get the tag this tag is locked to.
id | - The ID of the tag to query on |
virtual BOOL SetLockIDByID | ( | DWORD | id, |
DWORD | newLockID | ||
) | [pure virtual] |
set the tag this tag is locked to.
id | - The ID of the tag to query on |
newLockID | - value of 0 means not tagged |
virtual MSTR GetNameByID | ( | DWORD | id | ) | [pure virtual] |
get the tag's name
virtual void SetNameByID | ( | DWORD | id, |
MSTR & | newName | ||
) | [pure virtual] |
set the tag's name
virtual BOOL GetScaleByID | ( | DWORD | id | ) | [pure virtual] |
get whether to scale the tag's time when time is scaled
virtual void SetScaleByID | ( | DWORD | id, |
BOOL | newScale | ||
) | [pure virtual] |
set whether to scale the tag's time when time is scaled
virtual int FindItem | ( | DWORD | id | ) | [pure virtual] |
get the index of the tag in the sorted tag list.
virtual int FindItemByTime | ( | TimeValue | t | ) | [pure virtual] |
finds the first tag in the sorted list, if any, for the given absolute time value
virtual DWORD CreateNewTag | ( | MCHAR * | name, |
TimeValue | t, | ||
DWORD | lockID, | ||
BOOL | scale | ||
) | [pure virtual] |
creates a new tag.
name | - The name of the tag |
t | - The tags absolute time |
lockID | - The ID of the tag this new tag is locked too. if 0, the tag is not locked to another tag |
scale | - Whether or not to scale the tags time when time is scaled |
virtual void DeleteTag | ( | DWORD | id | ) | [pure virtual] |
deletes the specified tag
virtual void ResetFrameTags | ( | ) | [pure virtual] |
deletes all the tags
virtual BOOL CheckForLoop | ( | DWORD | testID, |
DWORD | id | ||
) | [pure virtual] |
returns true if tag testID is dependent on tag id