This reference page is linked to from the following overview topics: MotionBuilder 2013, Story.
Story Track class.
Tracks are containers for clips (medias), have a specific type which offer different functions.
#include <fbstory.h>
Public Member Functions | |
FBStoryTrack (FBStoryTrackType pTrackType, FBStoryFolder *pFolder=NULL, HIObject pObject=NULL) | |
Constructor. | |
FBStoryTrack (FBComponent *pSource, FBStoryFolder *pFolder=NULL, HIObject pObject=NULL) | |
Constructor. | |
virtual void | FBDelete () |
Virtual FBDelete function. | |
void | ChangeDetailsBegin () |
ChangeDetailsBegin. | |
void | ChangeDetailsEnd () |
ChangeDetailsEnd. | |
FBStoryClip * | CopyTakeIntoTrack (FBTimeSpan &pTimeSpan, FBTake *pTake, FBTime pOutputOffset=0, bool pMakeUndoable=false) |
CopyTakeIntoTrack Copy animation from the specified take for affected objects of the track. | |
void | EnableBodyPart (FBStoryTrackBodyPart pPart, bool pEnable) |
EnableBodyPart. | |
bool | IsBodyPartEnabled (FBStoryTrackBodyPart pPart) |
IsBodyPartEnabled. | |
void | AddClip (FBComponent *pClip, FBTime pTime) |
AddClip Add the clip to the track. | |
void | Load (bool pLoad) |
Allow to load/unload all story clips under this track. | |
Public Attributes | |
FBPropertyStoryTrackType | Type |
Read Only Property: Type of the track | |
FBPropertyString | Label |
Read Write Property: Label to display for this story track. | |
FBPropertyBool | Mute |
Read Write Property: If true, this track wont' play. | |
FBPropertyBool | Solo |
Read Write Property: If true, this track will be the only one to play. | |
FBPropertyString | RecordClipPath |
Read Write Property: Path for story recording. | |
FBPropertyString | ClipNameConvention |
Read Write Property: Naming convention for each new recording clip that is created. | |
FBPropertyBool | RecordTrack |
Read Write Property: Path for story recording. | |
FBPropertyStoryFolder | ParentFolder |
Read Only Property: Parent folder. | |
FBPropertyStoryTrack | ParentTrack |
Read Only Property: Parent track, if the track is of Character or Animation type. | |
FBPropertyListStorySubTrack | SubTracks |
List: Only Character and Animation tracks can have sub-tracks. | |
FBPropertyListStoryClip | Clips |
List: Clips contained in this track. | |
FBPropertyListStoryDetails | Details |
List: All objects associated to this track for processing. | |
FBPropertyAnimatableDouble | Weight |
Read Write Property: Control the blend amount. | |
FBPropertyBool | Ghost |
Read Write Property: Show ghosts | |
FBPropertyBool | GhostModel |
Read Write Property: Show ghost of models | |
FBPropertyBool | GhostTravelling |
Read Write Property: Show ghost of clip vector or traveling node | |
FBPropertyBool | GhostPivot |
Read Write Property: Show ghost of match object | |
FBPropertyBool | AcceptKey |
Read Write Property: Allow track to accept keys | |
FBPropertyStoryTrackRefMode | ReferenceMode |
Read Write Property: Track composition mode, kFBStoryTrackOverride or kFBStoryTrackAdditive | |
FBPropertyBool | OffsetEnable |
Read Write Property: When enabled, allow clip to be offset | |
FBPropertyBool | PassThrough |
Read Write Property: Enable passthrough of animation if there is no clip on track animation is taken from other tracks of take | |
FBPropertyCharacter | Character |
Read Write Property: Character to use. | |
FBPropertyInt | CharacterIndex |
Read Write Property: Character's index to use. | |
FBPropertyBool | ShowBackplate |
Read Write Property: If true, the backplate will be shown. | |
FBPropertyBool | ShowFrontplate |
Read Write Property: If true, the frontplate will be shown. | |
FBPropertyInt | AudioOutIndex |
Read Write Property: Audio Output's index to use. | |
FBPropertyVideo | TrackVideo |
Read Only Property: This FBVideo can be used as a texture. |
FBStoryTrack | ( | FBStoryTrackType | pTrackType, |
FBStoryFolder * | pFolder = NULL , |
||
HIObject | pObject = NULL |
||
) |
Constructor.
pTrackType | Type of the track to be created. |
pFolder | If NULL, parent will be the global root folder. |
pObject | For internal use only. |
FBStoryTrack | ( | FBComponent * | pSource, |
FBStoryFolder * | pFolder = NULL , |
||
HIObject | pObject = NULL |
||
) |
Constructor.
pSource | Source of the track to be created based on media component type. |
pFolder | If NULL, parent will be the global root folder. |
pObject | For internal use only. |
virtual void FBDelete | ( | ) | [virtual] |
void ChangeDetailsBegin | ( | ) |
ChangeDetailsBegin.
You must call this function before adding/removing any object to the Details list or it won't work.
void ChangeDetailsEnd | ( | ) |
ChangeDetailsEnd.
You must call this function after adding/removing any object to the Details list or it won't work.
FBStoryClip* CopyTakeIntoTrack | ( | FBTimeSpan & | pTimeSpan, |
FBTake * | pTake, | ||
FBTime | pOutputOffset = 0 , |
||
bool | pMakeUndoable = false |
||
) |
CopyTakeIntoTrack Copy animation from the specified take for affected objects of the track.
pTimeSpan | Time span for the clip to create. |
pTake | Take to get the animation from. |
pOutputOffset | Time offset for the clip if necessary. |
pMakeUndoable | If the operation should be undoable. |
void EnableBodyPart | ( | FBStoryTrackBodyPart | pPart, |
bool | pEnable | ||
) |
EnableBodyPart.
pPart | Which part to enable/disable. |
pEnable | If True, this will enable the body part solving while false will disable it. Enable a specific body part for character solving. |
bool IsBodyPartEnabled | ( | FBStoryTrackBodyPart | pPart | ) |
void AddClip | ( | FBComponent * | pClip, |
FBTime | pTime | ||
) |
AddClip Add the clip to the track.
void Load | ( | bool | pLoad | ) |
Allow to load/unload all story clips under this track.
FBPropertyStoryTrackType Type |
Read Only Property: Type of the track
Read Write Property: Label to display for this story track.
Read Write Property: If true, this track wont' play.
Read Write Property: If true, this track will be the only one to play.
Read Write Property: Path for story recording.
Can be relative or full path.
Read Write Property: Naming convention for each new recording clip that is created.
Can use special tags: <Name> <StartTCValue> <StartFrameValue> <StartDate> <StartTime> <TakeName>
Read Write Property: Path for story recording.
Can be relative or full path.
FBPropertyStoryFolder ParentFolder |
Read Only Property: Parent folder.
FBPropertyStoryTrack ParentTrack |
Read Only Property: Parent track, if the track is of Character or Animation type.
List: Only Character and Animation tracks can have sub-tracks.
List: Clips contained in this track.
List: All objects associated to this track for processing.
Read Write Property: Control the blend amount.
Reimplemented from FBConstraint.
Read Write Property: Show ghosts
Read Write Property: Show ghost of models
Read Write Property: Show ghost of clip vector or traveling node
Read Write Property: Show ghost of match object
Read Write Property: Allow track to accept keys
FBPropertyStoryTrackRefMode ReferenceMode |
Read Write Property: Track composition mode, kFBStoryTrackOverride or kFBStoryTrackAdditive
Read Write Property: When enabled, allow clip to be offset
Read Write Property: Enable passthrough of animation if there is no clip on track animation is taken from other tracks of take
FBPropertyCharacter Character |
Read Write Property: Character to use.
Read Write Property: Character's index to use.
Read Write Property: If true, the backplate will be shown.
Read Write Property: If true, the frontplate will be shown.
Read Write Property: Audio Output's index to use.
FBPropertyVideo TrackVideo |
Read Only Property: This FBVideo can be used as a texture.