Interface: FrameTagManager

Core Interfaces - Quick Navigation

The FrameTagManager Core Interface exposes the Time Tags to MAXScript.

See also Time Tags Access using the FrameTagManager Interface for examples.

Interface: FrameTagManager  

Methods:

<integer>FrameTagManager.GetTagCount() 	 

Returns the number of Time Tags.

<DWORD>FrameTagManager.GetTagID <index>index   

Returns the ID of the indexed Time Tag.

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

relative default value: false

Returns the time of the tag specified by ID.

If relative: is true, time is relative to the tag this tag is locked to, if any.

If relative: is false or not supplied, or this tag is not locked to another tag, the time is returned as absolute time.

<void>FrameTagManager.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 true, time is relative to the tag this tag is locked to, if any.

If relative: is false or not supplied, or this tag is not locked to another tag, the time is used as absolute time.

<DWORD>FrameTagManager.GetLockIDByID <DWORD>id 

Returns the ID of the tag the supplied tag is locked to.

An ID value of 0 means not locked.

<boolean>FrameTagManager.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>FrameTagManager.GetNameByID <DWORD>id 

Returns the name of the Time Tag specified by ID.

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

name is In parameter

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

<boolean>FrameTagManager.GetScaleByID <DWORD>id 

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

<void>FrameTagManager.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>FrameTagManager.FindItemByTime <time>time 

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

<index>FrameTagManager.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>FrameTagManager.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>FrameTagManager.DeleteTag <DWORD>id 

Deletes the tag specified by ID.

<void>FrameTagManager.ResetFrameTags() 

Deletes all tags.

<boolean>FrameTagManager.CheckForLoop <DWORD>testID <DWORD>id 

Returns true if tag testID is dependent on tag id