Interface: FrameTagManager

The FrameTagManager Interface exposes the Time Tags to MAXScript. See also Time Tags Access using the FrameTagManager Interface for examples.

Interface: FrameTagManager

Methods:

<integer>GetTagCount()

Returns the number of Time Tags.

<DWORD>GetTagID <index>index

Returns the ID of the indexed Time Tag.

<time>GetTimeByID <DWORD>id relative:<boolean>

relative default value: false

Returns the time of the tag specified by ID. If relative is false or not supplied, the time is returned as absolute time. If relative is 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.

<void>SetTimeByID <DWORD>id <time>time relative:<boolean>

relative default value: false

Sets the time of the tag specified by ID to the supplied time value. If relative is false or not supplied, the time is returned as absolute time. If relative is 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.

<DWORD>GetLockIDByID <DWORD>id

Returns the ID of the tag the supplied tag is locked to. An ID value of 0 means not locked.

<boolean>SetLockIDByID <DWORD>id <DWORD>lockID

Sets the ID of the tag the specified Tag is locked to. An ID value of 0 means not locked. Returns true on success. Attempting to set a lock that would cause a circular dependency will not change the current lock and the method will return false.

<string>GetNameByID <DWORD>id

Returns the name of the Time Tag specified by ID.

<void>SetNameByID <DWORD>id <&string>name

name is In parameter

Sets the name of the tag specified by ID to the supplied string.

<boolean>GetScaleByID <DWORD>id

Returns true if the time of the tag specified by ID will be scaled when the scene time is scaled.

<void>SetScaleByID <DWORD>id <boolean>scale

Set whether the time of the tag specified by ID will be scaled when the scene time is scaled.

<index>FindItemByTime <time>time

Returns the index of the first tag in the sorted list, if any, for the given
absolute time value
.

<index>FindItem <DWORD>id

Returns the index of the tag with the supplied ID in the sorted tag list. A return value of -1 means a tag with the given ID was not found.

<DWORD>CreateNewTag <string>name <time>time lockID:<DWORD> scale:<boolean>

lockID default value: 0

scale default value: true

Creates a new tag with the given name at the given time. If lockID is 0 or not supplied, the tag is not locked to another tag.

<void>DeleteTag <DWORD>id

Deletes the tag specified by ID.

<void>ResetFrameTags()

Deletes all tags.

<boolean>CheckForLoop <DWORD>testID <DWORD>id

Returns true if tag testID is dependent on tag id

See also:

Time Tags Access using the FrameTagManager Interface