FBStoryTrack Class Reference

Story Track class. More...

#include <pyfbsdk.h>

Inheritance diagram for FBStoryTrack:

Public Member Functions
	FBStoryTrack (FBStoryTrackType pTrackType, FBStoryFolder pFolder=None)
	Constructor.
	FBStoryTrack (FBComponent pSource, FBStoryFolder pFolder=None)
	Constructor.
	AddClip (FBComponent pClip, FBTime pTime)
	AddClip Add the clip to the track.
	ChangeDetailsBegin ()
	ChangeDetailsBegin.
	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.
FBStoryClip	CopyTakeIntoTrack (FBTimeSpan pTimeSpan, FBTake pTake, bool pConnectToCurrentTake, FBTime pOutputOffset=FBTime(0), bool pMakeUndoable=False)
	CopyTakeIntoTrack Copy animation from the specified take for affected objects of the track.
FBStoryTrack	CreateSubTrack (FBStoryTrackType pTrackType, FBStoryTrackRefMode pRefMode)
	Create a sub track, Only Character and Animation tracks can have sub-tracks.
	EnableBodyPart (FBStoryTrackBodyPart pPart, bool pEnable)
	EnableBodyPart.
	FBDelete ()
	Virtual FBDelete function.
bool	IsBodyPartEnabled (FBStoryTrackBodyPart pPart)
	IsBodyPartEnabled.
	Load (bool pLoad)
	Allow to load/unload all story clips under this track.
bool	PlotToCameraSwitcher (FBTake pTake)
	PlotToCameraSwitcher Plot the Shot Track to the Camera Switcher on the given Take.
Public Member Functions inherited from FBConstraint
	FBConstraint (str pName)
	Constructor.
FBAnimationNode	AnimationNodeInCreate (kReference pUserId, FBModel pModel, str pAttribute)
FBAnimationNode	AnimationNodeInCreate (kReference pUserId, FBProperty pProperty)
	Animation Node Creations (IN).
FBAnimationNode	AnimationNodeOutCreate (kReference pUserId, FBModel pModel, str pAttribute)
	Animation Node Creations (IN/OUT).
FBConstraint	Clone ()
	Clone the constraint.
bool	DeformerBind (FBModel pModel)
	Bind/Unbind pModel to deformation constraint.
bool	DeformerUnBind (FBModel pModel)
bool	Disable (FBModel pModel)
	Disable constraint on pModel.
	FreezeSRT (FBModel pModel, bool pS, bool pR, bool pT)
	Freeze current model state.
	FreezeSuggested ()
	Suggest 'freeze'.
bool	ReferenceAdd (int pGroupIndex, FBModel pModel)
	Add a reference to a specified group.
FBModel	ReferenceGet (int pGroupIndex, int pItemIndex=0)
	Get a reference.
int	ReferenceGetCount (int pGroupIndex)
	Get number of references in a specified group.
int	ReferenceGroupAdd (str pGroupName, int pMaxItemCount)
	Add a group of references.
int	ReferenceGroupGetCount ()
	Return the number of reference groups.
int	ReferenceGroupGetMaxCount (int pGroupIndex)
	Get the maximum number of items that can exist in the reference group in question.
str	ReferenceGroupGetName (int pGroupIndex)
	Get the name of the reference group.
bool	ReferenceRemove (int pGroupIndex, FBModel pModel)
	Remove a reference to pModel from the group at pGroupIndex.
	RemoveAllAnimationNodes ()
	Remove animation nodes.
	RestoreModelState (FBModel pModel)
	Restore the saved model state onto pModel.
	SaveModelState (FBModel pModel, bool pS, bool pR, bool pT)
	Save current state of pModel.
	SetupAllAnimationNodes ()
	Setup animation nodes.
	SnapSuggested ()
	Suggest 'snap'.
Public Member Functions inherited from FBBox
	FBBox (str pName)
	Constructor.
bool	AnimationNodeDestroy (FBAnimationNode pAnimationNode)
	Destroy an animation node.
FBAnimationNode	AnimationNodeInGet ()
	Get the (IN/OUT) animation node for this box.
bool	AnimationNodeIsUserData (FBAnimationNode pAnimationNode)
	Is the animation node user data?
FBAnimationNode	AnimationNodeOutGet ()
str	FbxGetObjectSubType ()
	Returns the class sub type inherited by the class of an object, for example: 'Relations', 'Parent-Child', 'Number to Vector', 'Shot'.
str	FbxGetObjectType ()
	Returns the class type inherited by the class of an object, for example: 'Box', 'Constraint', 'TimelineXTrack'.
FBAnimationNode	GetInConnector (int pIndex)
	Get the animation node input associated with the given index.
int	GetInConnectorCount ()
	Get the number of animation node inputs for this box.
FBAnimationNode	GetOutConnector (int pIndex)
	Get the animation node output associated with the given index.
int	GetOutConnectorCount ()
	Get the number of animation node outputs for this box.
Public Member Functions inherited from FBComponent
	FBComponent ()
	Constructor.
str	ClassName ()
	Get the class name.
	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.
	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.
bool	FBCreate ()
	Open Reality Creation function.
	FBDelete ()
	Open Reality deletion function.
	FBDestroy ()
	Open Reality destruction function.
FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).
bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.
FBFileReference	GetOwnerFileReference (p0)
	Get the owner FileReference object.
	HardSelect ()
	HardSelect.
bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.
bool	Is (int pTypeId)
	Returns true if object is of type TypeId.
bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessNamespaceHierarchy.
bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessObjectNamespace.
int	PropertyAdd (FBProperty pProperty)
	Add a property to the component's property manager.
bool	PropertyAddReferenceProperty (FBProperty pReferenceProperty)
	Add a reference property to the component's property manager.
FBProperty	PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
	Create user or dynamic property.
	PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.
	PropertyRemove (FBProperty pProperty)
	Remove a Property from the component's Property manager.
	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.
	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

Public Attributes
bool	AcceptKey
	Read Write Property: Allow track to accept keys
int	AudioOutIndex
	Read Write Property: Audio Output's index to use.
FBCharacter	Character
	Read Write Property: Character to use.
int	CharacterIndex
	Read Write Property: Character's index to use.
str	ClipNameConvention
	Read Write Property: Naming convention for each new recording clip that is created. Can use special tags: <Name> <StartTCValue> <StartFrameValue> <StartDate> <StartTime> <TakeName>
FBListStoryClip	Clips
	List: Clips contained in this track.
FBListStoryDetails	Details
	List: All objects associated to this track for processing.
bool	Ghost
	Read Write Property: Show ghosts
bool	GhostModel
	Read Write Property: Show ghost of models
bool	GhostPivot
	Read Write Property: Show ghost of match object
FBStoryTrackGhostShowMode	GhostShowTrackMode
	Read Write Property: Show the ghosts for all the clips or only the adjacent clips. See FBStoryTrackGhostShowMode
bool	GhostTravelling
	Read Write Property: Show ghost of clip vector or traveling node
str	Label
	Read Write Property: Label to display for this story track.
bool	Mute
	Read Write Property: If true, this track wont' play.
bool	OffsetEnable
	Read Write Property: When enabled, allow clip to be offset
FBStoryFolder	ParentFolder
	Read Only Property: Parent folder.
FBStoryTrack	ParentTrack
	Read Only Property: Parent track, if the track is of Character or Animation type.
bool	PassThrough
	Read Write Property: Enable passthrough of animation if there is no clip on track animation is taken from other tracks of take
str	RecordClipPath
	Read Write Property: Path for story recording. Can be relative or full path.
bool	RecordTrack
	Read Write Property: Path for story recording. Can be relative or full path.
FBStoryTrackRefMode	ReferenceMode
	Read Write Property: Track composition mode, kFBStoryTrackOverride or kFBStoryTrackAdditive
bool	ShowBackplate
	Read Write Property: If true, the backplate will be shown.
bool	ShowFrontplate
	Read Write Property: If true, the frontplate will be shown.
bool	Solo
	Read Write Property: If true, this track will be the only one to play.
FBListStorySubTrack	SubTracks
	List: Only Character and Animation tracks can have sub-tracks.
FBVideo	TrackVideo
	Read Only Property: This FBVideo can be used as a texture.
FBStoryTrackType	Type
	Read Only Property: Type of the track
FBAnimatableDouble	Weight
	Read Write Property: Control the blend amount.
Public Attributes inherited from FBConstraint
bool	Active
	Read Write Property: Active state.
bool	Deformer
	Read Write Property: Is a deformer constraint?
str	Description
	Read Write Property: Long description of constraint.
bool	HasLayout
	Read Write Property: Does the constraint have a layout?
bool	Lock
	Read Write Property: Lock state.
FBAction	Snap
	Function Property: Snap constraint.
FBAnimatableDouble	Weight
	Read Write Property: Weight of constraint.
Public Attributes inherited from FBBox
bool	Animatable
	Read Write Property: Is the box animatable.
bool	Live
	Read Write Property: Is live?
bool	RecordMode
	Read Write Property: Is recording?
str	UniqueName
	internal Unique name.
Public Attributes inherited from FBComponent
FBListComponent	Components
	List: List of components.
str	LongName
	Read Write Property: Name and namespace for object.
str	Name
	Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.
FBListComponent	Parents
	List: Parents.
FBManager	PropertyList
	Read Only Property: Manages all of the properties for the component.
bool	Selected
	Read Write Property: Selected property.
int	TypeInfo
	Contains the Type information of the object.
Public Attributes inherited from FBPlug
str	ClassGroupName
	ClassGroupName of the object.
int	TypeInfo
	TypeInfo.

Detailed 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)

See samples: CreateShotClip.py, AudioTrackSetupTool.py, BloopSlate.py, RecordLight.py, FBStoryFolder.py, VideoClip.py, PlotNonSelectedCharStoryTracks.py, PlotSelectedCharStoryTracks.py, PrintClipNamesAndStartStopFrames.py.

Constructor & Destructor Documentation

FBStoryTrack() [1/2]

FBStoryTrack	(	FBStoryTrackType	pTrackType,
		FBStoryFolder	pFolder = None
	)

Constructor.

Parameters

pTrackType	Type of the track to be created.
pFolder	If NULL, parent will be the global root folder.

FBStoryTrack() [2/2]

FBStoryTrack	(	FBComponent	pSource,
		FBStoryFolder	pFolder = None
	)

Constructor.

Parameters

pSource	Source of the track to be created based on media component type.
pFolder	If NULL, parent will be the global root folder.

Member Function Documentation

AddClip()

AddClip	(	FBComponent	pClip,
		FBTime	pTime
	)

AddClip Add the clip to the track.

ChangeDetailsBegin()

ChangeDetailsBegin

(

)

ChangeDetailsBegin.

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

ChangeDetailsEnd()

ChangeDetailsEnd

(

)

ChangeDetailsEnd.

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

CopyTakeIntoTrack() [1/2]

FBStoryClip CopyTakeIntoTrack	(	FBTimeSpan	pTimeSpan,
		FBTake	pTake,
		bool	pConnectToCurrentTake,
		FBTime	pOutputOffset = FBTime(0),
		bool	pMakeUndoable = False
	)

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

Parameters

pTimeSpan	Time span for the clip to create.
pTake	Take to get the animation from.
pConnectToCurrentTake	True to connect the created clip to the current take, false otherwise.
pOutputOffset	Time offset for the clip if necessary.
pMakeUndoable	If the operation should be undoable.

Returns

Created story clip if the operation succeeded, NULL otherwise.

CopyTakeIntoTrack() [2/2]

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.

This method will always connect the created clip to the current take.

Parameters

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.

Returns

Created story clip if the operation succeeded, NULL otherwise.

CreateSubTrack()

FBStoryTrack CreateSubTrack	(	FBStoryTrackType	pTrackType,
		FBStoryTrackRefMode	pRefMode
	)

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

Parameters

pTrackType	Type of the sub track to be created.
pRefMode	Composition mode of the sub track, kFBStoryTrackOverride or kFBStoryTrackAdditive.

Returns

Created sub story track if the operation succeeded otherwise NULL.

EnableBodyPart()

EnableBodyPart	(	FBStoryTrackBodyPart	pPart,
		bool	pEnable
	)

EnableBodyPart.

Parameters

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.

FBDelete()

FBDelete

(

)

Virtual FBDelete function.

See sample: DeleteHierarchy.py.

IsBodyPartEnabled()

bool IsBodyPartEnabled

(

FBStoryTrackBodyPart

pPart

)

IsBodyPartEnabled.

Is a specific body part is enabled.

Load()

Load

(

bool

pLoad

)

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

Remarks

Currently only animation clips are supported.

PlotToCameraSwitcher()

bool PlotToCameraSwitcher

(

FBTake

pTake

)

PlotToCameraSwitcher Plot the Shot Track to the Camera Switcher on the given Take.

This undoable operation will overwrite the Camera Switcher of Take.

Parameters

pTake

Take to plot the Shot Track to the Camera Switcher to.

Returns

True if the operation is successful, false otherwise.

Remarks

To plot all Shot Tracks to the Camera Switcher, use the FBStory.PlotAllShotTracksToCameraSwitcher method.

Member Data Documentation

AcceptKey

bool AcceptKey

Read Write Property: Allow track to accept keys

AudioOutIndex

int AudioOutIndex

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

Character

FBCharacter Character

Read Write Property: Character to use.

CharacterIndex

int CharacterIndex

Read Write Property: Character's index to use.

ClipNameConvention

str ClipNameConvention

Read Write Property: Naming convention for each new recording clip that is created. Can use special tags: <Name> <StartTCValue> <StartFrameValue> <StartDate> <StartTime> <TakeName>

Clips

FBListStoryClip Clips

List: Clips contained in this track.

Details

FBListStoryDetails Details

List: All objects associated to this track for processing.

Ghost

bool Ghost

Read Write Property: Show ghosts

GhostModel

bool GhostModel

Read Write Property: Show ghost of models

GhostPivot

bool GhostPivot

Read Write Property: Show ghost of match object

GhostShowTrackMode

FBStoryTrackGhostShowMode GhostShowTrackMode

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

GhostTravelling

bool GhostTravelling

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

Label

str Label

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

Mute

bool Mute

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

OffsetEnable

bool OffsetEnable

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

ParentFolder

FBStoryFolder ParentFolder

Read Only Property: Parent folder.

ParentTrack

FBStoryTrack ParentTrack

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

PassThrough

bool PassThrough

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

RecordClipPath

str RecordClipPath

Read Write Property: Path for story recording. Can be relative or full path.

RecordTrack

bool RecordTrack

Read Write Property: Path for story recording. Can be relative or full path.

ReferenceMode

FBStoryTrackRefMode ReferenceMode

Read Write Property: Track composition mode, kFBStoryTrackOverride or kFBStoryTrackAdditive

ShowBackplate

bool ShowBackplate

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

ShowFrontplate

bool ShowFrontplate

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

Solo

bool Solo

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

SubTracks

FBListStorySubTrack SubTracks

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

TrackVideo

FBVideo TrackVideo

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

Type

FBStoryTrackType Type

Read Only Property: Type of the track

Weight

FBAnimatableDouble Weight

Read Write Property: Control the blend amount.