Story Track class. More...

#include <fbstory.h>

Inheritance diagram for FBStoryTrack:

[legend]

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 () override
	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.

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.

void	EnableBodyPart (FBStoryTrackBodyPart pPart, bool pEnable)
	EnableBodyPart.

bool	IsBodyPartEnabled (FBStoryTrackBodyPart pPart)
	IsBodyPartEnabled.

bool	PlotToCameraSwitcher (FBTake *pTake)
	PlotToCameraSwitcher Plot the Shot Track to the Camera Switcher on the given Take.

void	AddClip (FBComponent *pClip, FBTime pTime)
	AddClip Add the clip to the track.

FBStoryTrack *	CreateSubTrack (FBStoryTrackType pTrackType, FBStoryTrackRefMode pRefMode)
	Create a sub track, Only Character and Animation tracks can have sub-tracks.

void	Load (bool pLoad)
	Allow to load/unload all story clips under this track.

Public Member Functions inherited from FBConstraint
	FBConstraint (const char *pName, HIObject pObject=NULL)
	Constructor.

	IObject_Declare (override)

virtual void	ActiveChanged ()
	Notification for Activation Status Change.

virtual void	RemoveAllAnimationNodes ()
	Remove animation nodes.

virtual void	SetupAllAnimationNodes ()
	Setup animation nodes.

virtual void	SnapSuggested ()
	Suggest 'snap'.

virtual void	FreezeSuggested ()
	Suggest 'freeze'.

virtual bool	Disable (FBModel *pModel)
	Disable constraint on pModel.

virtual bool	Enable (FBModel *pModel)
	Enable constraint on pModel.

virtual bool	AnimationNodeNotify (FBAnimationNode pAnimationNode, FBEvaluateInfo pEvaluateInfo, FBConstraintInfo *pConstraintInfo)
	Notification callback for connectors.

FBAnimationNode *	AnimationNodeOutCreate (kReference pUserId, FBModel pModel, const char pAttribute)
	Animation Node Creations (IN/OUT).

FBAnimationNode *	AnimationNodeInCreate (kReference pUserId, FBModel pModel, const char pAttribute)

FBAnimationNode *	AnimationNodeInCreate (kReference pUserId, FBProperty *pProperty)
	Animation Node Creations (IN).

virtual void	SaveModelState (FBModel *pModel, bool pS, bool pR, bool pT)
	Save current state of pModel.

virtual void	RestoreModelState (FBModel *pModel)
	Restore the saved model state onto pModel.

virtual void	FreezeSRT (FBModel *pModel, bool pS, bool pR, bool pT)
	Freeze current model state.

virtual FBConstraint *	Clone ()
	Clone the constraint.

int	ReferenceGroupGetCount ()
	Return the number of reference groups.

int	ReferenceGroupAdd (const char *pGroupName, int pMaxItemCount)
	Add a group of references.

const char *	ReferenceGroupGetName (int pGroupIndex)
	Get the name of the reference group.

int	ReferenceGroupGetMaxCount (int pGroupIndex)
	Get the maximum number of items that can exist in the reference group in question.

FBModel *	ReferenceGet (int pGroupIndex, int pItemIndex=0)
	Get a reference.

int	ReferenceGetCount (int pGroupIndex)
	Get number of references in a specified group.

bool	ReferenceAdd (int pGroupIndex, FBModel *pModel)
	Add a reference to a specified group.

bool	ReferenceRemove (int pGroupIndex, FBModel *pModel)
	Remove a reference to pModel from the group at pGroupIndex.

void	ReferenceRemoveAll ()
	Remove All References.

virtual bool	ReferenceAddNotify (int pGroupIndex, FBModel *pModel)
	Notification callbacks for when a reference is added or removed.

virtual bool	ReferenceRemoveNotify (int pGroupIndex, FBModel *pModel)

virtual bool	DeformerPreNotify (FBModel pModel, FBEvaluateInfo pEvaluateInfo, FBVertex pBBoxMin, FBVertex pBBoxMax)
	Deformation pre-notification function This function pass the evaluation information for deformation (if timing is required).

virtual bool	DeformerNotify (FBModel pModel, const FBVertex pSrcVertex, const FBVertex pSrcNormal, int pCount, FBVertex pDstVertex, FBVertex *pDstNormal)
	Deformation notification function.

virtual bool	DeformerBind (FBModel *pModel)
	Bind/Unbind pModel to deformation constraint.

virtual bool	DeformerUnBind (FBModel *pModel)

virtual bool	FbxStore (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat) override
	Store/Retrieve data to/from FBX files.

virtual bool	FbxRetrieve (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat) override

Public Member Functions inherited from FBBox
	FBBox (const char *pName, HIObject pObject=NULL)
	Constructor.

virtual FBAnimationNode *	AnimationNodeInCreate (kReference pUserId, const char pName, const char pDataType, bool pIsPublic=false, double pMin=NULL, double pMax=NULL, bool pUserData=false)
	Creation of IN/OUT Animation Nodes.

virtual FBAnimationNode *	AnimationNodeOutCreate (kReference pUserId, const char pName, const char pDataType, bool pIsPublic=false, double pMin=NULL, double pMax=NULL, bool pUserData=false)

virtual bool	EvaluateAnimationNodes (FBEvaluateInfo *pEvaluateInfo)
	Evaluation of non TRS nodes that needs to be evaluated.

virtual bool	AnimationNodeNotify (FBAnimationNode pAnimationNode, FBEvaluateInfo pEvaluateInfo)
	Notification function for animation thread.

virtual bool	ResolveCandidate (FBAnimationNode pAnimationNode, FBEvaluateInfo pEvaluateInfo)
	Function is call when candidate needs to be resolved (like global to local).

virtual ECandidateAction	SetGlobalCandidate (FBAnimationNode pAnimationNode, double pData, FBEvaluateInfo *pEvaluateInfo)
	Function is call when a global candidate is set on an animation node.

virtual ECandidateAction	SetStdCandidate (FBAnimationNode pAnimationNode, double pData, FBEvaluateInfo *pEvaluateInfo)
	Function is call when a non-global candidate is set on an animation node.

virtual bool	FbxStore (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat)
	Storage/Retrieval of information into the FBX file format.

virtual bool	FbxRetrieve (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat)

virtual bool	AnimationNodeDestroy (FBAnimationNode *pAnimationNode)
	Destroy an animation node.

virtual bool	AnimationNodeIsUserData (FBAnimationNode *pAnimationNode)
	Is the animation node user data?

virtual void	AnimationNodesOutDisableIfNotWritten (FBEvaluateInfo *pEvaluateInfo)
	This call will disable all out animation nodes from being pull by system (animation thread) for given pEvaluateInfo.

virtual FBAnimationNode *	AnimationNodeInGet ()
	Get the (IN/OUT) animation node for this box.

virtual FBAnimationNode *	AnimationNodeOutGet ()

virtual const char *	FbxGetObjectType ()
	Returns the class type inherited by the class of an object, for example: 'Box', 'Constraint', 'TimelineXTrack'.

virtual const char *	FbxGetObjectSubType ()
	Returns the class sub type inherited by the class of an object, for example: 'Relations', 'Parent-Child', 'Number to Vector', 'Shot'.

	IObject_Declare (override)

virtual int	GetOutConnectorCount () const
	Get the number of animation node outputs for this box.

virtual int	GetInConnectorCount () const
	Get the number of animation node inputs for this box.

virtual FBAnimationNode *	GetOutConnector (int pIndex) const
	Get the animation node output associated with the given index.

virtual FBAnimationNode *	GetInConnector (int pIndex) const
	Get the animation node input associated with the given index.

Public Member Functions inherited from FBComponent
	FBComponent (HIObject pObject)
	Constructor.

virtual	~FBComponent ()
	Destructor.

virtual bool	FBCreate ()
	Open Reality Creation function.

virtual void	FBDestroy ()
	Open Reality destruction function.

virtual void	FBDelete () override
	Open Reality deletion function.

virtual bool	SetHIObject (HIObject pObject, bool pSDKComponent) override
	Assign component to an internal pointer.

virtual 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.

void	PropertyRemove (FBProperty *pProperty)
	Remove a Property from the component's Property manager.

void	PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.

FBProperty *	PropertyCreate (const char pName, FBPropertyType pType, const char pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
	Create user or dynamic property.

FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).

void	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.

bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.

void	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.

void	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.

void	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessNamespaceHierarchy.

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessObjectNamespace.

virtual const char *	ClassName () override
	Get the class name.

virtual bool	UseCustomPropertyViewSet () const
	Use the custom property viewSet or not.

const char *	GetFullName (void)
	Get the full name.

void	SetOwnerNamespace (FBNamespace *pOwnerNSObj)
	Set the owner Namespace object.

FBNamespace *	GetOwnerNamespace (void)
	Get the owner Namespace object.

FBFileReference *	GetOwnerFileReference (void)
	Get the owner FileReference object.

void	HardSelect ()
	HardSelect.

virtual bool	Is (int pTypeId) override
	Returns true if object is of type TypeId.

virtual int	GetTypeId () override
	GetTypeId( int pTypeId )

Public Member Functions inherited from FBWrapperHolder
FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject.

void	AddWrapper (FBScriptWrapper *)

void	RemoveWrapper (FBScriptWrapper *)

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. Can be relative or full path.

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>

FBPropertyBool	RecordTrack
	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.

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

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

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.

Public Attributes inherited from FBConstraint
FBPropertyBool	Deformer
	Read Write Property: Is a deformer constraint?

FBPropertyBool	HasLayout
	Read Write Property: Does the constraint have a layout?

FBPropertyString	Description
	Read Write Property: Long description of constraint.

FBPropertyBool	Active
	Read Write Property: Active state.

FBPropertyBool	Lock
	Read Write Property: Lock state.

FBPropertyAction	Snap
	Function Property: Snap constraint.

FBPropertyAnimatableDouble	Weight
	Read Write Property: Weight of constraint.

Public Attributes inherited from FBBox
const char *	UniqueName
	internal Unique name.

FBPropertyBool	Animatable
	Read Write Property: Is the box animatable.

FBPropertyBool	Live
	Read Write Property: Is live?

FBPropertyBool	RecordMode
	Read Write Property: Is recording?

Public Attributes inherited from FBComponent
FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component.

FBPropertyListComponent	Components
	List: List of components.

FBPropertyListComponent	Parents
	List: Parents.

FBPropertyBool	Selected
	Read Write Property: Selected property.

FBPropertyString	Name
	Read Write Property: Unique name of object.

FBPropertyString	LongName
	Read Write Property: Name and namespace for object.

FBPropertyFolder	Folder
	Read Write Property: The folder that contain this component.

Additional Inherited Members
Public Types inherited from FBBox
enum	ECandidateAction { eCandidateAccept , eCandidateIntercept , eCandidateInterceptAfterEvaluation }
	Resolving action for candidates. More...

Static Public Member Functions inherited from FBComponent
static int	GetInternalClassId ()

static void	FBComponentSetName (FBComponent pObject, const char pName)

static const char *	FBComponentGetName (FBComponent *pObject)

static void	FBComponentSetLongName (FBComponent pObject, const char pName)

static const char *	FBComponentGetLongName (FBComponent *pObject)

Static Public Attributes inherited from FBComponent
static int	TypeInfo
	Contains the Type information of the object.

Protected Member Functions inherited from FBPlug
bool	IsSDKComponent ()
	Return whether or not item is an SDK component.

bool	ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.

bool	ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.

bool	ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.

bool	ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.

bool	DisconnectDst (FBPlug *pDst)
	Remove a destination connection.

bool	DisconnectSrc (FBPlug *pSrc)
	Remove a source connection.

void	DisconnectAllSrc ()
	Remove all source connections.

void	DisconnectAllDst ()
	Remove all destination connections.

bool	DisconnectDstAt (int pIndex)
	Remove a destination connection at a specified index.

bool	DisconnectSrcAt (int pIndex)
	Remove a source connection at a specified index.

bool	ReplaceDstAt (int pIndex, FBPlug *pDst)
	Replace a destination connection at a specified index.

bool	ReplaceSrcAt (int pIndex, FBPlug *pSrc)
	Replace a source connection at a specified index.

bool	SwapSrc (int pIndexA, int pIndexB)
	Swap source connection at index A with source connection at index B.

bool	MoveSrcAt (int pIndex, int pAtIndex)
	Move source connection at pIndex to pAtIndex.

bool	MoveSrcAt (FBPlug pSrc, FBPlug pAtSrc)
	Move source connection pSrc to the position of pAtSrc.

int	GetSrcCount ()
	Get source connection count.

FBPlug *	GetSrc (int pIndex)
	Get a source connection's plug at specified index.

FBConnectionType	GetSrcType (int pIndex)
	Get a source connection's type at specified index.

int	GetDstCount ()
	Get destination connection count.

FBPlug *	GetDst (int pIndex)
	Get a destination connection's plug at specified index.

FBConnectionType	GetDstType (int pIndex)
	Get a destination connection's type at specified index.

bool	BeginChange ()
	Begins a change on multiple plugs.

void	EndChange ()
	Ends a change on multiple plugs.

void	SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's self modification flag.

bool	GetSelfModified (FBPlugModificationFlag pFlag)
	Tell if the plug's self has changed.

void	SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's owned property/object's modification flag.

bool	GetContentModified (FBPlugModificationFlag pFlag)
	Tell if the plug's content has changed.

int	GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
	Get plug's modified src/dst property/object connection added/removed List.

bool	RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
	Revert the plug's modification to original status.

void	SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
	Set the plug's status flag.

bool	GetStatusFlag (FBPlugStatusFlag pStatus) const
	Tell if the plug's status has changed.

FBPlug *	GetOwner ()
	Get the owner of this plug.

FBPlug *	GetOwned (int pIndex)
	Get the owned plug at specified index.

int	GetOwnedCount ()
	Get the owned plug count.

virtual const char *	ClassName ()
	internal System vars.

virtual bool	Is (int pTypeId)
	Is( int pTypeId )

virtual int	GetTypeId ()
	GetTypeId( int pTypeId )

virtual bool	PlugDataNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only.

virtual bool	PlugStateNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only.

virtual bool	PlugNotify (FBConnectionAction pAction, FBPlug pThis, int pIndex, FBPlug pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL)
	PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only.

virtual void	FBDelete ()
	Actual destructor for a FBPlug.

Static Protected Member Functions inherited from FBPlug
static int	GetInternalClassId ()
	Internal class Id.

Protected Attributes inherited from FBPlug
bool	mAllocated
	Contain the Allocation State of the Component.

HIObject	mObject
	Handle on the Plug.

bool	mSDKComponent
	bool Plug is an SDK component.

Static Protected Attributes inherited from FBPlug
static const char *	ClassGroupName
	ClassGroupName of the object.

static int	TypeInfo
	TypeInfo.

static int	mGlobalTypeInfo
	Represente the Type Index.

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)

Definition at line 652 of file fbstory.h.

Constructor & Destructor Documentation

◆ FBStoryTrack() [1/2]

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

Constructor.

Parameters

pTrackType	Type of the track to be created.
pFolder	If NULL, parent will be the global root folder.
pObject	For internal use only.

◆ FBStoryTrack() [2/2]

FBStoryTrack	(	FBComponent *	pSource,
		FBStoryFolder *	pFolder = `NULL`,
		HIObject	pObject = `NULL`
	)

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.
pObject	For internal use only.

Member Function Documentation

◆ AddClip()

void AddClip	(	FBComponent *	pClip,
		FBTime	pTime
	)

AddClip Add the clip to the track.

◆ ChangeDetailsBegin()

void ChangeDetailsBegin ( )

ChangeDetailsBegin.

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

◆ ChangeDetailsEnd()

void 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()

void 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()

virtual void FBDelete ( )

overridevirtual

Virtual FBDelete function.

Reimplemented from FBComponent.

◆ IsBodyPartEnabled()

bool IsBodyPartEnabled ( FBStoryTrackBodyPart pPart )

IsBodyPartEnabled.

Is a specific body part is enabled.

◆ Load()

void 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.

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

Parameters

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

Returns: True if the operation is successful, false otherwise.

Member Data Documentation

◆ AcceptKey

FBPropertyBool AcceptKey

Read Write Property: Allow track to accept keys

Definition at line 772 of file fbstory.h.

◆ AudioOutIndex

FBPropertyInt AudioOutIndex

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

Definition at line 786 of file fbstory.h.

◆ Character

FBPropertyCharacter Character

Read Write Property: Character to use.

Definition at line 778 of file fbstory.h.

◆ CharacterIndex

FBPropertyInt CharacterIndex

Read Write Property: Character's index to use.

Definition at line 779 of file fbstory.h.

◆ ClipNameConvention

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>

Definition at line 755 of file fbstory.h.

◆ Clips

FBPropertyListStoryClip Clips

List: Clips contained in this track.

Definition at line 760 of file fbstory.h.

◆ Details

FBPropertyListStoryDetails Details

List: All objects associated to this track for processing.

Definition at line 761 of file fbstory.h.

◆ Ghost

FBPropertyBool Ghost

Read Write Property: Show ghosts

Definition at line 767 of file fbstory.h.

◆ GhostModel

FBPropertyBool GhostModel

Read Write Property: Show ghost of models

Definition at line 768 of file fbstory.h.

◆ GhostPivot

FBPropertyBool GhostPivot

Read Write Property: Show ghost of match object

Definition at line 770 of file fbstory.h.

◆ GhostShowTrackMode

FBPropertyStoryTrackGhostShowMode GhostShowTrackMode

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

Definition at line 771 of file fbstory.h.

◆ GhostTravelling

FBPropertyBool GhostTravelling

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

Definition at line 769 of file fbstory.h.

◆ Label

FBPropertyString Label

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

Definition at line 751 of file fbstory.h.

◆ Mute

FBPropertyBool Mute

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

Definition at line 752 of file fbstory.h.

◆ OffsetEnable

FBPropertyBool OffsetEnable

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

Definition at line 774 of file fbstory.h.

◆ ParentFolder

FBPropertyStoryFolder ParentFolder

Read Only Property: Parent folder.

Definition at line 757 of file fbstory.h.

◆ ParentTrack

FBPropertyStoryTrack ParentTrack

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

Definition at line 758 of file fbstory.h.

◆ PassThrough

FBPropertyBool PassThrough

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 775 of file fbstory.h.

◆ RecordClipPath

FBPropertyString RecordClipPath

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

Definition at line 754 of file fbstory.h.

◆ RecordTrack

FBPropertyBool RecordTrack

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

Definition at line 756 of file fbstory.h.

◆ ReferenceMode

FBPropertyStoryTrackRefMode ReferenceMode

Read Write Property: Track composition mode, kFBStoryTrackOverride or kFBStoryTrackAdditive

Definition at line 773 of file fbstory.h.

◆ ShowBackplate

FBPropertyBool ShowBackplate

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

Definition at line 782 of file fbstory.h.

◆ ShowFrontplate

FBPropertyBool ShowFrontplate

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

Definition at line 783 of file fbstory.h.

◆ Solo

FBPropertyBool Solo

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

Definition at line 753 of file fbstory.h.

◆ SubTracks

FBPropertyListStorySubTrack SubTracks

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

Definition at line 759 of file fbstory.h.

◆ TrackVideo

FBPropertyVideo TrackVideo

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

Definition at line 789 of file fbstory.h.

◆ Type

FBPropertyStoryTrackType Type

Read Only Property: Type of the track

Definition at line 750 of file fbstory.h.

◆ Weight

FBPropertyAnimatableDouble Weight

Read Write Property: Control the blend amount.

Definition at line 764 of file fbstory.h.

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

fbstory.h

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBStoryTrack() [1/2]

◆ FBStoryTrack() [2/2]

Member Function Documentation

◆ AddClip()

◆ ChangeDetailsBegin()

◆ ChangeDetailsEnd()

◆ CopyTakeIntoTrack() [1/2]

◆ CopyTakeIntoTrack() [2/2]

◆ CreateSubTrack()

◆ EnableBodyPart()

◆ FBDelete()

◆ IsBodyPartEnabled()

◆ Load()

◆ PlotToCameraSwitcher()

Member Data Documentation

◆ AcceptKey

◆ AudioOutIndex

◆ Character

◆ CharacterIndex

◆ ClipNameConvention

◆ Clips

◆ Details

◆ Ghost

◆ GhostModel

◆ GhostPivot

◆ GhostShowTrackMode

◆ GhostTravelling

◆ Label

◆ Mute

◆ OffsetEnable

◆ ParentFolder

◆ ParentTrack

◆ PassThrough

◆ RecordClipPath

◆ RecordTrack

◆ ReferenceMode

◆ ShowBackplate

◆ ShowFrontplate

◆ Solo

◆ SubTracks

◆ TrackVideo

◆ Type

◆ Weight