FBStoryTrack Class Reference

#include <mobu-python-api.h>

Class Description

Story Track class.

Tracks are containers for clips (medias), have a specific type which offer different functions. Note: To change the travelling node of a track, search for the "TravellingNode" property on the track and then connect/disconnect the appropriate object. Python example: lPropTravellingNode = lAnimTrack.PropertyList.Find("TravellingNode") lCube.ConnectDst(lPropTravellingNode)

+ Inheritance diagram for FBStoryTrack:

Public Member Functions

 __reduce__ ()
 
 __init__ (...)
 
 ChangeDetailsBegin (FBStoryTrack arg1)
 ChangeDetailsBegin. More...
 
 ChangeDetailsEnd (FBStoryTrack arg1)
 ChangeDetailsEnd. More...
 
 EnableBodyPart (FBStoryTrack arg1, FBStoryTrackBodyPart arg2, object arg3)
 EnableBodyPart. More...
 
 FBDelete (FBStoryTrack arg1)
 Virtual FBDelete function. More...
 
 Load (FBStoryTrack arg1, object arg2)
 Allow to load/unload all story clips under this track. More...
 
bool IsBodyPartEnabled (FBStoryTrack arg1, FBStoryTrackBodyPart arg2)
 IsBodyPartEnabled. More...
 
object CopyTakeIntoTrack (FBStoryTrack arg1, FBTimeSpan arg2, FBTake arg3, FBTime arg4, object arg5)
 CopyTakeIntoTrack Copy animation from the specified take for affected objects of the track. More...
 
 AddClip (FBStoryTrack arg1, FBComponent arg2, FBTime arg3)
 AddClip Add the clip to the track. More...
 
object CreateSubTrack (FBStoryTrack arg1, FBStoryTrackType arg2, FBStoryTrackRefMode arg3)
 Create a sub track, Only Character and Animation tracks can have sub-tracks. More...
 
- Public Member Functions inherited from FBConstraint
 __reduce__ ()
 
object AnimationNodeInCreate (FBConstraint arg1, object arg2, FBModel arg3, str arg4)
 
object __copy__ (FBConstraint arg1)
 
object AnimationNodeOutCreate (FBConstraint arg1, object arg2, FBModel arg3, str arg4)
 Animation Node Creations (IN/OUT). More...
 
object Clone (FBConstraint arg1)
 Clone the constraint. More...
 
bool DeformerBind (FBConstraint arg1, FBModel arg2)
 Bind/Unbind pModel to deformation constraint. More...
 
bool DeformerUnBind (FBConstraint arg1, FBModel arg2)
 
bool Disable (FBConstraint arg1, FBModel arg2)
 Disable constraint on pModel. More...
 
 FreezeSRT (FBConstraint arg1, FBModel arg2, object arg3, object arg4, object arg5)
 Freeze current model state. More...
 
 FreezeSuggested (FBConstraint arg1)
 Suggest 'freeze'. More...
 
bool ReferenceAdd (FBConstraint arg1, object arg2, FBModel arg3)
 Add a reference to a specified group. More...
 
object ReferenceGet (FBConstraint arg1, object arg2, object arg3)
 Get a reference. More...
 
int ReferenceGetCount (FBConstraint arg1, object arg2)
 Get number of references in a specified group. More...
 
int ReferenceGroupAdd (FBConstraint arg1, str arg2, object arg3)
 Add a group of references. More...
 
int ReferenceGroupGetCount (FBConstraint arg1)
 Return the number of reference groups. More...
 
int ReferenceGroupGetMaxCount (FBConstraint arg1, object arg2)
 Get the maximum number of items that can exist in the reference group in question. More...
 
str ReferenceGroupGetName (FBConstraint arg1, object arg2)
 Get the name of the reference group. More...
 
bool ReferenceRemove (FBConstraint arg1, object arg2, FBModel arg3)
 Remove a reference to pModel from the group at pGroupIndex. More...
 
 RemoveAllAnimationNodes (FBConstraint arg1)
 Remove animation nodes. More...
 
 RestoreModelState (FBConstraint arg1, FBModel arg2)
 Restore the saved model state onto pModel. More...
 
 SaveModelState (FBConstraint arg1, FBModel arg2, object arg3, object arg4, object arg5)
 Save current state of pModel. More...
 
 SetupAllAnimationNodes (FBConstraint arg1)
 Setup animation nodes. More...
 
 Snap (FBConstraint arg1)
 Function Property: Snap constraint. More...
 
 SnapSuggested (FBConstraint arg1)
 Suggest 'snap'. More...
 
 __init__ (...)
 Constructor. More...
 
- Public Member Functions inherited from FBBox
 __reduce__ ()
 
bool AnimationNodeDestroy (FBBox arg1, FBAnimationNode arg2)
 Destroy an animation node. More...
 
 __init__ (object arg1, str arg2)
 Constructor. More...
 
object AnimationNodeInGet (FBBox arg1)
 Get the (IN/OUT) animation node for this box. More...
 
bool AnimationNodeIsUserData (FBBox arg1, FBAnimationNode arg2)
 Is the animation node user data? More...
 
object AnimationNodeOutGet (FBBox arg1)
 
int GetOutConnectorCount (FBBox arg1)
 Get the number of animation node outputs for this box. More...
 
int GetInConnectorCount (FBBox arg1)
 Get the number of animation node inputs for this box. More...
 
object GetOutConnector (FBBox arg1, object arg2)
 Get the animation node output associated with the given index. More...
 
object GetInConnector (FBBox arg1, object arg2)
 Get the animation node input associated with the given index. More...
 
- Public Member Functions inherited from FBComponent
 __reduce__ ()
 
FBPropertyList PropertyGetModifiedList (FBComponent arg1, FBPlugModificationFlag arg2)
 Get list of properties which have been modified since last loading. More...
 
str ClassName (FBComponent arg1)
 Get the class name. More...
 
 DisableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
 Disable a specific Object Flags. More...
 
 EnableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
 Enable a specific Object Flags. More...
 
bool FBCreate (FBComponent arg1)
 Open Reality Creation function. More...
 
 FBDelete (FBComponent arg1)
 Open Reality deletion function. More...
 
 FBDestroy (FBComponent arg1)
 Open Reality destruction function. More...
 
FBObjectFlag GetObjectFlags (FBComponent arg1)
 Get all Object Flags (concatenated). More...
 
bool GetObjectStatus (FBComponent arg1, FBObjectStatus arg2)
 Check to see if an object status is enabled. More...
 
bool HasObjectFlags (FBComponent arg1, FBObjectFlag arg2)
 Check whether a specific object flag is enabled. More...
 
bool Is (FBComponent arg1, object arg2)
 Returns true if object is of type TypeId. More...
 
bool ProcessNamespaceHierarchy (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
 ProcessNamespaceHierarchy. More...
 
bool ProcessObjectNamespace (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
 ProcessObjectNamespace. More...
 
int PropertyAdd (FBComponent arg1, FBProperty arg2)
 Add a property to the component's property manager. More...
 
bool PropertyAddReferenceProperty (FBComponent arg1, FBProperty arg2)
 Add a reference property to the component's property manager. More...
 
object PropertyCreate (FBComponent arg1, str arg2, FBPropertyType arg3, str arg4, object arg5, object arg6, FBProperty arg7)
 Create user or dynamic property. More...
 
 PropertyRemove (FBComponent arg1, FBProperty arg2)
 Remove a Property from the component's Property manager. More...
 
 SetObjectFlags (FBComponent arg1, FBObjectFlag arg2)
 SetObjectFlags. More...
 
 SetObjectStatus (FBComponent arg1, FBObjectStatus arg2, object arg3)
 Enable/Disable a specific Object Status. More...
 
 HardSelect (FBComponent arg1)
 HardSelect. More...
 
object GetOwnerFileReference (FBComponent arg1)
 Get the owner FileReference object. More...
 
 __init__ (...)
 Constructor. More...
 
- Public Member Functions inherited from FBPlug
 __reduce__ ()
 
bool BeginChange (FBPlug arg1)
 Begins a change on multiple plugs. More...
 
str ClassName (FBPlug arg1)
 internal System vars. More...
 
bool ConnectDst (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
 Add a destination connection. More...
 
bool ConnectDstAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
 Add a destination connection. More...
 
bool ConnectSrc (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
 Add a source connection. More...
 
bool ConnectSrcAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
 Add a source connection. More...
 
 DisconnectAllDst (FBPlug arg1)
 Remove all destination connections. More...
 
 DisconnectAllSrc (FBPlug arg1)
 Remove all source connections. More...
 
bool DisconnectDst (FBPlug arg1, FBPlug arg2)
 Remove a destination connection. More...
 
bool DisconnectDstAt (FBPlug arg1, object arg2)
 Remove a destination connection at a specified index. More...
 
bool DisconnectSrc (FBPlug arg1, FBPlug arg2)
 Remove a source connection. More...
 
bool DisconnectSrcAt (FBPlug arg1, object arg2)
 Remove a source connection at a specified index. More...
 
 EndChange (FBPlug arg1)
 Ends a change on multiple plugs. More...
 
object GetDst (FBPlug arg1, object arg2)
 Get a destination connection's plug at specified index. More...
 
int GetDstCount (FBPlug arg1)
 Get destination connection count. More...
 
FBConnectionType GetDstType (FBPlug arg1, object arg2)
 Get a destination connection's type at specified index. More...
 
object GetOwned (FBPlug arg1, object arg2)
 Get the owned plug at specified index. More...
 
int GetOwnedCount (FBPlug arg1)
 Get the owned plug count. More...
 
object GetOwner (FBPlug arg1)
 Get the owner of this plug. More...
 
object GetSrc (FBPlug arg1, object arg2)
 Get a source connection's plug at specified index. More...
 
int GetSrcCount (FBPlug arg1)
 Get source connection count. More...
 
FBConnectionType GetSrcType (FBPlug arg1, object arg2)
 Get a source connection's type at specified index. More...
 
bool Is (FBPlug arg1, object arg2)
 Is( int pTypeId ) More...
 
bool IsSDKComponent (FBPlug arg1)
 Return whether or not item is an SDK component. More...
 
 MoveSrcAt (...)
 
bool ReplaceDstAt (FBPlug arg1, object arg2, FBPlug arg3)
 Replace a destination connection at a specified index. More...
 
bool ReplaceSrcAt (FBPlug arg1, object arg2, FBPlug arg3)
 Replace a source connection at a specified index. More...
 
bool SwapSrc (FBPlug arg1, object arg2, object arg3)
 Swap source connection at index A with source connection at index B. More...
 
 SetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
 Set the plug's self modification flag. More...
 
bool GetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2)
 Tell if the plug's self has changed. More...
 
 SetContentModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
 Set the plug's owned property/object's modification flag. More...
 
bool GetContentModified (FBPlug arg1, FBPlugModificationFlag arg2)
 Tell if the plug's content has changed. More...
 
int GetPlugConnectionModifiedList (FBPlug arg1, FBPlugList arg2, FBPlugModificationFlag arg3, object arg4)
 Get plug's modified src/dst property/object connection added/removed List. More...
 
bool RevertModification (FBPlug arg1, FBPlugModificationFlag arg2)
 Revert the plug's modification to original status. More...
 
 __init__ (...)
 
method staticmethod (function)
 
- Public Member Functions inherited from FBPythonWrapper
 __reduce__ ()
 
 __init__ (...)
 

Public Attributes

FBPropertyBool AcceptKey
 Read Write Property: Allow track to accept keys More...
 
FBPropertyInt AudioOutIndex
 Read Write Property: Audio Output's index to use. More...
 
FBPropertyAnimatableDouble Weight
 Read Write Property: Control the blend amount. More...
 
FBPropertyCharacter Character
 Read Write Property: Character to use. More...
 
FBPropertyInt CharacterIndex
 Read Write Property: Character's index to use. More...
 
ORSDK2018::FBPropertyListStoryClip Clips
 List: Clips contained in this track. More...
 
ORSDK2018::FBPropertyListStoryDetails Details
 List: All objects associated to this track for processing. More...
 
FBPropertyBool Ghost
 Read Write Property: Show ghosts More...
 
FBPropertyBool GhostModel
 Read Write Property: Show ghost of models More...
 
FBPropertyBool GhostPivot
 Read Write Property: Show ghost of match object More...
 
FBPropertyBool GhostTravelling
 Read Write Property: Show ghost of clip vector or traveling node More...
 
FBPropertyStoryTrackGhostShowMode GhostShowTrackMode
 Read Write Property: Show the ghosts for all the clips or only the adjacent clips. More...
 
ORSDK2018::FBPropertyString Label
 Read Write Property: Label to display for this story track. More...
 
FBPropertyBool Mute
 Read Write Property: If true, this track wont' play. More...
 
FBPropertyBool OffsetEnable
 Read Write Property: When enabled, allow clip to be offset More...
 
FBPropertyStoryFolder ParentFolder
 Read Only Property: Parent folder. More...
 
FBPropertyStoryTrack ParentTrack
 Read Only Property: Parent track, if the track is of Character or Animation type. More...
 
FBPropertyBool PassThrough
 Read Write Property: Enable passthrough of animation if there is no clip on track animation is taken from other tracks of take More...
 
FBPropertyStoryTrackRefMode ReferenceMode
 Read Write Property: Track composition mode, kFBStoryTrackOverride or kFBStoryTrackAdditive More...
 
FBPropertyBool ShowBackplate
 Read Write Property: If true, the backplate will be shown. More...
 
FBPropertyBool ShowFrontplate
 Read Write Property: If true, the frontplate will be shown. More...
 
FBPropertyBool Solo
 Read Write Property: If true, this track will be the only one to play. More...
 
ORSDK2018::FBPropertyString RecordClipPath
 Read Write Property: Path for story recording. More...
 
ORSDK2018::FBPropertyString ClipNameConvention
 Read Write Property: Naming convention for each new recording clip that is created. More...
 
FBPropertyBool RecordTrack
 Read Write Property: Path for story recording. More...
 
ORSDK2018::FBPropertyListStorySubTrack SubTracks
 List: Only Character and Animation tracks can have sub-tracks. More...
 
FBPropertyVideo TrackVideo
 Read Only Property: This FBVideo can be used as a texture. More...
 
FBPropertyStoryTrackType Type
 Read Only Property: Type of the track More...
 
- Public Attributes inherited from FBConstraint
FBPropertyBool Active
 Read Write Property: Active state. More...
 
FBPropertyBool Deformer
 Read Write Property: Is a deformer constraint? More...
 
ORSDK2018::FBPropertyString Description
 Read Write Property: Long description of constraint. More...
 
FBPropertyBool HasLayout
 Read Write Property: Does the constraint have a layout? More...
 
FBPropertyBool Lock
 Read Write Property: Lock state. More...
 
FBPropertyAnimatableDouble Weight
 Read Write Property: Weight of constraint. More...
 
- Public Attributes inherited from FBBox
FBPropertyBool Animatable
 Read Write Property: Is the box animatable. More...
 
FBPropertyBool Live
 Read Write Property: Is live? More...
 
FBPropertyBool RecordMode
 Read Write Property: Is recording? More...
 
const char * UniqueName
 internal Unique name. More...
 
- Public Attributes inherited from FBComponent
object OwnerNamespace
 
ORSDK2018::FBPropertyListComponent Components
 List: List of components. More...
 
ORSDK2018::FBPropertyString Name
 Read Write Property: Unique name of object. More...
 
ORSDK2018::FBPropertyString LongName
 Read Write Property: Name and namespace for object. More...
 
object FullName
 
ORSDK2018::FBPropertyListComponent Parents
 List: Parents. More...
 
ORSDK2018::FBPropertyManager PropertyList
 Read Only Property: Manages all of the properties for the component. More...
 
FBPropertyBool Selected
 Read Write Property: Selected property. More...
 
- Public Attributes inherited from FBPythonWrapper
object OnUnbind
 

Member Function Documentation

__init__ (   ...)

Python Docstring:

__init__( (object)arg1, (FBStoryTrackType)arg2 [, (FBStoryFolder)arg3]) -> None

__init__( (object)arg1, (FBComponent)arg2 [, (FBStoryFolder)arg3]) -> None 

C++ Constructors:
The reference documentation for the following C++ symbols may contain additional relevant information.

__reduce__ ( )
AddClip ( FBStoryTrack  arg1,
FBComponent  arg2,
FBTime  arg3 
)

AddClip Add the clip to the track.

Python Docstring:

AddClip( (FBStoryTrack)arg1, (FBComponent)arg2, (FBTime)arg3) -> None 

C++ Signature:

void AddClip(ORSDK2018::FBComponent * pClip, ORSDK2018::FBTime pTime) 
ChangeDetailsBegin ( FBStoryTrack  arg1)

ChangeDetailsBegin.

Python Docstring:

ChangeDetailsBegin( (FBStoryTrack)arg1) -> None 

C++ Signature:

void ChangeDetailsBegin() 

You must call this function before adding/removing any object to the Details list or it won't work.

ChangeDetailsEnd ( FBStoryTrack  arg1)

ChangeDetailsEnd.

Python Docstring:

ChangeDetailsEnd( (FBStoryTrack)arg1) -> None 

C++ Signature:

void ChangeDetailsEnd() 

You must call this function after adding/removing any object to the Details list or it won't work.

object CopyTakeIntoTrack ( FBStoryTrack  arg1,
FBTimeSpan  arg2,
FBTake  arg3,
FBTime  arg4,
object  arg5 
)

CopyTakeIntoTrack Copy animation from the specified take for affected objects of the track.

Python Docstring:

CopyTakeIntoTrack( (FBStoryTrack)arg1, (FBTimeSpan)arg2, (FBTake)arg3 [, (FBTime)arg4 [, (object)arg5]]) -> object 

C++ Signature:

ORSDK2018::FBStoryClip * CopyTakeIntoTrack(ORSDK2018::FBTimeSpan & pTimeSpan, ORSDK2018::FBTake * pTake, ORSDK2018::FBTime pOutputOffset = 0, bool pMakeUndoable = false) 
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.
object CreateSubTrack ( FBStoryTrack  arg1,
FBStoryTrackType  arg2,
FBStoryTrackRefMode  arg3 
)

Create a sub track, Only Character and Animation tracks can have sub-tracks.

Python Docstring:

CreateSubTrack( (FBStoryTrack)arg1, (FBStoryTrackType)arg2, (FBStoryTrackRefMode)arg3) -> object 

C++ Signature:

ORSDK2018::FBStoryTrack * CreateSubTrack(FBStoryTrackType pTrackType, FBStoryTrackRefMode pRefMode) 
Parameters
pTrackTypeType of the sub track to be created.
pRefModeComposition mode of the sub track, kFBStoryTrackOverride or kFBStoryTrackAdditive.
Returns
Created sub story track if the operation succeeded otherwise NULL.
EnableBodyPart ( FBStoryTrack  arg1,
FBStoryTrackBodyPart  arg2,
object  arg3 
)

EnableBodyPart.

Python Docstring:

EnableBodyPart( (FBStoryTrack)arg1, (FBStoryTrackBodyPart)arg2, (object)arg3) -> None 

C++ Signature:

void EnableBodyPart(FBStoryTrackBodyPart pPart, bool pEnable) 
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.
FBDelete ( FBStoryTrack  arg1)

Virtual FBDelete function.

Python Docstring:

FBDelete( (FBStoryTrack)arg1) -> None 

C++ Signature:

void FBDelete() 
bool IsBodyPartEnabled ( FBStoryTrack  arg1,
FBStoryTrackBodyPart  arg2 
)

IsBodyPartEnabled.

Python Docstring:

IsBodyPartEnabled( (FBStoryTrack)arg1, (FBStoryTrackBodyPart)arg2) -> bool 

C++ Signature:

bool IsBodyPartEnabled(FBStoryTrackBodyPart pPart) 

Is a specific body part is enabled.

Load ( FBStoryTrack  arg1,
object  arg2 
)

Allow to load/unload all story clips under this track.

Python Docstring:

Load( (FBStoryTrack)arg1, (object)arg2) -> None 

C++ Signature:

void Load(bool pLoad) 
Remarks
Currently only animation clips are supported.

Member Data Documentation

FBPropertyBool AcceptKey

Read Write Property: Allow track to accept keys

FBPropertyInt AudioOutIndex

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

FBPropertyCharacter Character

Read Write Property: Character to use.

FBPropertyInt CharacterIndex

Read Write Property: Character's index to use.

ORSDK2018::FBPropertyString ClipNameConvention

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

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

ORSDK2018::FBPropertyListStoryClip Clips

List: Clips contained in this track.

ORSDK2018::FBPropertyListStoryDetails Details

List: All objects associated to this track for processing.

Read Write Property: Show ghosts

FBPropertyBool GhostModel

Read Write Property: Show ghost of models

FBPropertyBool GhostPivot

Read Write Property: Show ghost of match object

FBPropertyStoryTrackGhostShowMode GhostShowTrackMode

Read Write Property: Show the ghosts for all the clips or only the adjacent clips.

See FBStoryTrackGhostShowMode

FBPropertyBool GhostTravelling

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

ORSDK2018::FBPropertyString Label

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

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

FBPropertyBool OffsetEnable

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

FBPropertyStoryFolder ParentFolder

Read Only Property: Parent folder.

FBPropertyStoryTrack ParentTrack

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

FBPropertyBool PassThrough

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

ORSDK2018::FBPropertyString RecordClipPath

Read Write Property: Path for story recording.

Can be relative or full path.

FBPropertyBool RecordTrack

Read Write Property: Path for story recording.

Can be relative or full path.

FBPropertyStoryTrackRefMode ReferenceMode

Read Write Property: Track composition mode, kFBStoryTrackOverride or kFBStoryTrackAdditive

FBPropertyBool ShowBackplate

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

FBPropertyBool ShowFrontplate

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

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

ORSDK2018::FBPropertyListStorySubTrack SubTracks

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

FBPropertyVideo TrackVideo

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

FBPropertyStoryTrackType Type

Read Only Property: Type of the track

Read Write Property: Control the blend amount.