Public Member Functions | Public Attributes

FBStoryTrack Class Reference

This reference page is linked to from the following overview topics: MotionBuilder 2013, Story.


Search for all occurrences

Detailed Description

Story Track class.

Tracks are containers for clips (medias), have a specific type which offer different functions.

Definition at line 467 of file fbstory.h.

#include <fbstory.h>

Inheritance diagram for FBStoryTrack:
Inheritance graph
[legend]

List of all members.

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.
FBStoryClipCopyTakeIntoTrack (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.

Constructor & Destructor Documentation

FBStoryTrack ( FBStoryTrackType  pTrackType,
FBStoryFolder pFolder = NULL,
HIObject  pObject = NULL 
)

Constructor.

Parameters:
pTrackTypeType of the track to be created.
pFolderIf NULL, parent will be the global root folder.
pObjectFor internal use only.
FBStoryTrack ( FBComponent pSource,
FBStoryFolder pFolder = NULL,
HIObject  pObject = NULL 
)

Constructor.

Parameters:
pSourceSource of the track to be created based on media component type.
pFolderIf NULL, parent will be the global root folder.
pObjectFor internal use only.

Member Function Documentation

virtual void FBDelete ( ) [virtual]

Virtual FBDelete function.

Reimplemented from FBComponent.

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.

Parameters:
pTimeSpanTime span for the clip to create.
pTakeTake to get the animation from.
pOutputOffsetTime offset for the clip if necessary.
pMakeUndoableIf the operation should be undoable.
Returns:
Created story clip if the operation succeeded otherwize NULL.
void EnableBodyPart ( FBStoryTrackBodyPart  pPart,
bool  pEnable 
)

EnableBodyPart.

Parameters:
pPartWhich part to enable/disable.
pEnableIf 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)

IsBodyPartEnabled.

Is a specific body part is enabled.

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.

Remarks:
Currently only animation clips are supported.

Member Data Documentation

FBPropertyStoryTrackType Type

Read Only Property: Type of the track

Definition at line 536 of file fbstory.h.

Read Write Property: Label to display for this story track.

Definition at line 537 of file fbstory.h.

Read Write Property: If true, this track wont' play.

Definition at line 538 of file fbstory.h.

Read Write Property: If true, this track will be the only one to play.

Definition at line 539 of file fbstory.h.

Read Write Property: Path for story recording.

Can be relative or full path.

Definition at line 540 of file fbstory.h.

Read Write Property: Naming convention for each new recording clip that is created.

Can use special tags: <Name> <StartTCValue> <StartFrameValue> <StartDate> <StartTime> <TakeName>

Definition at line 541 of file fbstory.h.

Read Write Property: Path for story recording.

Can be relative or full path.

Definition at line 542 of file fbstory.h.

FBPropertyStoryFolder ParentFolder

Read Only Property: Parent folder.

Definition at line 543 of file fbstory.h.

FBPropertyStoryTrack ParentTrack

Read Only Property: Parent track, if the track is of Character or Animation type.

Definition at line 544 of file fbstory.h.

List: Only Character and Animation tracks can have sub-tracks.

Definition at line 545 of file fbstory.h.

List: Clips contained in this track.

Definition at line 546 of file fbstory.h.

List: All objects associated to this track for processing.

Definition at line 547 of file fbstory.h.

Read Write Property: Control the blend amount.

Reimplemented from FBConstraint.

Definition at line 550 of file fbstory.h.

Read Write Property: Show ghosts

Definition at line 553 of file fbstory.h.

Read Write Property: Show ghost of models

Definition at line 554 of file fbstory.h.

Read Write Property: Show ghost of clip vector or traveling node

Definition at line 555 of file fbstory.h.

Read Write Property: Show ghost of match object

Definition at line 556 of file fbstory.h.

Read Write Property: Allow track to accept keys

Definition at line 557 of file fbstory.h.

FBPropertyStoryTrackRefMode ReferenceMode

Read Write Property: Track composition mode, kFBStoryTrackOverride or kFBStoryTrackAdditive

Definition at line 558 of file fbstory.h.

Read Write Property: When enabled, allow clip to be offset

Definition at line 559 of file fbstory.h.

Read Write Property: Enable passthrough of animation if there is no clip on track animation is taken from other tracks of take

Definition at line 560 of file fbstory.h.

FBPropertyCharacter Character

Read Write Property: Character to use.

Definition at line 563 of file fbstory.h.

Read Write Property: Character's index to use.

Definition at line 564 of file fbstory.h.

Read Write Property: If true, the backplate will be shown.

Definition at line 567 of file fbstory.h.

Read Write Property: If true, the frontplate will be shown.

Definition at line 568 of file fbstory.h.

Read Write Property: Audio Output's index to use.

Definition at line 571 of file fbstory.h.

FBPropertyVideo TrackVideo

Read Only Property: This FBVideo can be used as a texture.

Definition at line 574 of file fbstory.h.


The documentation for this class was generated from the following file:

FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack
FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack