Story Clip class. More...

#include <fbstory.h>

Inheritance diagram for FBStoryClip:

[legend]

Public Member Functions
	FBStoryClip (FBComponent pClipObject, FBStoryTrack pTrack, FBTime pTime, HIObject pObject=NULL)
	Constructor.

	FBStoryClip (const char pFilePath, FBStoryTrack pTrack, FBTime pTime, HIObject pObject=NULL)
	Constructor.

	FBStoryClip (const char pFilePath, FBStoryTrack pTrack, FBTime pTime, FBTime pTimeOffset, HIObject pObject=NULL)
	Constructor.

virtual void	FBDelete () override
	Virtual FBDelete function.

FBStoryClip *	Clone ()
	Clone the clip.

FBTime	Move (FBTime pDelta, bool pForce=true)
	Move.

FBTime	MoveTo (FBTime pTime, bool pForce=true)
	MoveTo.

FBStoryClip *	Razor (FBTime pTime)
	Razor.

void	Match ()
	Match.

void	Match (FBString pObjectName, FBStoryClipMatchingTimeType pTimeType, FBStoryClipMatchingTranslationType pTranslationType, FBStoryClipMatchingRotationType pRotationType)
	Match.

bool	ExportToFile (FBString pOutputFile)
	ExportToFile.

bool	GetReadOnly ()
	GetReadOnly Retrieves the clip read-only status.

bool	SetReadOnly (bool pMakeClipReadOnly, FBString pOutputFile=FBString())
	SetReadOnly Assigns the clip read-only status.

bool	MakeWritable ()
	MakeWritable.

void	GetAffectedObjects (FBArrayTemplate< FBComponent * > *pAffectedObjects)
	GetAffectedObjects.

void	GetAffectedAnimationNodes (FBArrayTemplate< FBAnimationNode * > pAffectedAnimationNodes, FBComponent pClipObject)
	GetAffectedAnimationNodes.

bool	DestinationSetObject (const char pSrcName, FBComponent pObject)
	Assign source to destination if the pSrcName is found in source list and pObject is in the Details list.

void	SetTime (FBTime pSourceIn=NULL, FBTime pSourceOut=NULL, FBTime pDestinationIn=NULL, FBTime pDestinationOut=NULL, bool pUseAlternateSrcInProp=false)
	SetTime Sets any in/out values for the source/destination times.

bool	CanAssignSourcesToDestinations ()
	CanAssignSourcesToDestinations.

K_DEPRECATED_2023 void	GetAssignSourcesToDestinationsInfo (FBStringList &pSrcList, FBStringList &pAvailableDstList, FBStringList &pDefaultDstList, FBStringList &pEffectiveDstList)
	GetAssignSourcesToDestinationsInfo.

void	GetAssignSourcesToDestinationsInfo (FBStringList &pSrcList, FBArrayBool &pValidAnimatedSrc, FBStringList &pAvailableDstList, FBArrayBool &pValidAnimatedDst, FBStringList &pDefaultDstList, FBStringList &pEffectiveDstList)
	GetAssignSourcesToDestinationsInfo.

bool	SetAssignSourcesToDestinationsInfo (FBStringList &pEffectiveDstList)
	SetAssignSourcesToDestinationsInfo.

fbxsdk::FbxScene *	GetFbxScene ()
	Get KFbxScene.

bool	UpdateFromCurrentTake ()
	Update clip animation from current take animation for clip track's scope, works only for clip created by Insert Current Take and connected to current take.

FBTime	GetSourceTimeFromDestinationTime (FBTime pDestinationTime, int *pLoopNumber=nullptr)
	Get the clip source time (internal time) from a destination time (local time).

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
FBPropertyColor	Color
	Read Write Property: Color of the clip.

FBPropertyTime	Start
	Read Write Property: Start time of the clip local to its track.

FBPropertyTime	Stop
	Read Write Property: Stop time of the clip local to its track.

K_DEPRECATED_2026 FBPropertyTime	MarkIn
	Read Write Property: Start time inside the clip.

K_DEPRECATED_2026 FBPropertyTime	MarkOut
	Read Write Property: Stop time inside the clip.

FBPropertyTime	FirstLoopMarkIn
	Read Write Property: For a read-only clip, the start time inside the clip for its first loop. For a writable clip, use the SourceMarkIn property instead.

FBPropertyTime	LastLoopMarkOut
	Read Write Property: For a read-only clip, the end time inside the clip for its last loop. For a writable clip, use the Stop property instead.

FBPropertyTime	SourceMarkIn
	Read Write Property: For a read-only clip, the start time inside the clip for all the loops except its first loop. For a writable clip, the start time inside the clip.

FBPropertyTime	SourceMarkOut
	Read Write Property: For a read-only clip, the stop time inside the clip for all the loops except its last loop. For a writable clip, use the Stop property instead.

FBPropertyTimeSpan	PreBlend
	Read Write Property: Start/Stop time of the pre-blend phase.

FBPropertyTimeSpan	PostBlend
	Read Write Property: Start/Stop time of the post-blend phase.

FBPropertyTime	Offset
	Read Write Property: First loop time offset.

FBPropertyDouble	Speed
	Read Write Property: Speed of the clip.

FBPropertyBool	StartStopLocked
	Read Write Property: Clip's 'In/Out Locked' property value. True if the clip's In/Out properties (start/stop times of the clip local to its track) are locked, false otherwise.

FBPropertyCamera	ShotCamera
	Read Write Property: The camera used for that specific shot.

FBPropertyVideo	ShotBackplate
	Read Write Property: The backplate used for that specific shot.

FBPropertyVideo	ShotFrontplate
	Read Write Property: The frontplate used for that specific shot.

FBPropertyBool	ShowBackplate
	Read Write Property: Enable/Disable the shot backplate.

FBPropertyBool	ShowFrontplate
	Read Write Property: Enable/Disable the shot frontplate.

FBPropertyTime	ShotActionStart
	Read Write Property: If not in locked shot mode (time discontinuity enabled), this time can be different from the Clip->Start property.

FBPropertyTime	ShotActionStop
	Read Write Property: If not in locked shot mode (time discontinuity enabled), this time can be different from the Clip->Start property.

FBPropertyBool	ShotStartStopLocked
	Read Write Property: Shot clip's 'In/Out Locked' property value. True if the shot clip's In/Out properties (start/stop times of the clip local to its track) are locked, false otherwise.

FBPropertyAudioClip	AudioClip
	Read Only Property: The audio clip used by this StoryClip.

FBPropertyString	ClipAudioPath
	Read Write Property: Audio clip's file path

FBPropertyDouble	ClipPitch
	Read Write Property: The clip pitch value.

FBPropertyBool	LockPitchToSpeed
	Read Write Property: Time-stretching enabled or not.

FBPropertyString	ClipVideoPath
	Read Write Property: Video clip's file path

FBPropertyBool	ImageSequence
	Read Write Property: Whether is a image sequence.

FBPropertyBool	UseSystemFrameRate
	Read Write Property: Whether always use system frame rate.

FBPropertyDouble	FrameRate
	Read Write Property: Frame rate value. Only effective when UseSystemFrameRate is false.

K_DEPRECATED_2024 FBPropertyBool	ShowEmbeddedTimecode
	Read Write Property: Whether to show the embedded timecode (real, if available, or custom) of the video.

FBPropertyString	ClipAnimationPath
	Read Write Property: Animation clip's file path

FBPropertyDouble	Scale
	Read Write Property: Animation clip's scaling (some don't support this property)

FBPropertyVector3d	Translation
	Read Write Property: Animation clip's translation offset. Refer to class notes to learn more about how this is applied.

FBPropertyVector3d	Rotation
	Read Write Property: Animation clip's rotation offset. Refer to class notes to learn more about how this is applied.

FBPropertyVector3d	LoopTranslation
	Read Write Property: Animation clip's loop translation.

FBPropertyBool	AutoLoop
	Read Write Property: If true, clip will automatically loop

FBPropertyBool	Loop
	Read Write Property: If true, loop clip's animation

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

FBPropertyStoryClipShowGhostMode	ShowGhostClipMode
	Read Write Property: Show the ghost depending on the time. See FBStoryClipShowGhostMode

FBPropertyTime	GhostCustomTime
	Read Write Property: Custom time to display ghost, only applicable if ShowGhostClipMode is kFBStoryClipTimeCustom.

FBPropertyAnimationNode	PreBlendData
	Read Only Property: To get the animation of the Pre blend curve

FBPropertyAnimationNode	PostBlendData
	Read Only Property: To get the animation of the Post blend curve

FBPropertyListPivot	Pivots
	List: Pivots models (Generally, only one model is necessary)

FBPropertyBool	Loaded
	Read Write Property: If true, clip file is loaded into memory and can be evaluated (will affect track content).

FBPropertyVector3d	GhostManipulatorOffset
	Read Write Property: Animation clip's ghost manipulator offset.

FBPropertyListObject	TravellingNode
	List: Travelling node(s). If set, this property will overwrite the Track's Travelling node(s).

FBPropertyStoryClipNodeFunction	TravellingNodeFunction
	Read Write Property: Travelling node function. If set, this property will overwrite the Track's Travelling node function. See FBStoryClipNodeFunction.

FBPropertyStoryClipGhostTimeMode	GhostManipulatorMode
	Read Write Property: Time mode to display ghost manipulator. See FBStoryClipGhostTimeMode.

FBPropertyTime	GhostManipulatorCustomTime
	Read Write Property: Custom time to display ghost manipulator, only applicable if GhostManipulatorMode is kFBStoryClipGhostCustom.

FBPropertyBool	ConnectedToTake
	Read Write Property: When connected to current take, user can do updating from current take, but user can't edit clip animation by adding keys, only works for clips created by Insert Current Take.

FBPropertyStoryClipSolveMode	SolvingMode
	Read Write Property: Solve Modes for story character clips. See FBStoryClipSolveMode

FBPropertyBool	MirrorAnimation
	Read Write Property: If true, clip animation will be mirrored

FBPropertyStoryClipMirrorPlane	MirrorPlane
	Read Write Property: Several mirror planes to mirror animation. See FBStoryClipMirrorPlane

FBPropertyEvent	OnChange
	Event: Something in the clip has changed. (FBEventClip)

FBPropertyBool	TimeWarpEnabled
	Read Write Property: Animation and Shot clip's TimeWarp activeness.

FBPropertyStoryClipTimeWarpInterpolatorType	TimeWarpInterpolatorType
	Read Write Property: Animation and Shot clip's TimeWarp interpolation type. See FBStoryClipTimeWarpInterpolatorType.

FBPropertyBool	TimeWarpReverse
	Read Write Property: If true, reverse the Animation or Shot clip's TimeWarp FCurve.

FBPropertyAnimationNode	CustomTimeWarp
	Read Only Property: Animation and Shot clip's custom TimeWarp FCurve.

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
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 Clip class.

Clips represents media, at a specific time, for a specific duration, in a track.

Clip offset is depending on Traveling node and Traveling node function. First we compute clip transformation matrix, where scaling is always 1, 1, 1. Translation is in position of Traveling node at clip first frame. Rotation is based on vector from first to last frame position of Traveling node. On top of that we apply offset and expose that as Clip Offset T & R. When you change clip offset T or R we extract clip offset based on current clip transformation matrix. Clip transformation matrix can change when Traveling node change or Traveling node function change.

Definition at line 809 of file fbstory.h.

Constructor & Destructor Documentation

◆ FBStoryClip() [1/3]

FBStoryClip	(	FBComponent *	pClipObject,
		FBStoryTrack *	pTrack,
		FBTime	pTime,
		HIObject	pObject = `NULL`
	)

Constructor.

Parameters

pClipObject	Object (media data) for the clip.
pTrack	The track in which we create the clip.
pTime	Time where the clip should begin.
pObject	For internal use only.

◆ FBStoryClip() [2/3]

FBStoryClip	(	const char *	pFilePath,
		FBStoryTrack *	pTrack,
		FBTime	pTime,
		HIObject	pObject = `NULL`
	)

Constructor.

Parameters

pFilePath	Media file path to create clip with.
pTrack	The track in which we create the clip.
pTime	Time where the clip should begin.
pObject	For internal use only.

◆ FBStoryClip() [3/3]

FBStoryClip	(	const char *	pFilePath,
		FBStoryTrack *	pTrack,
		FBTime	pTime,
		FBTime	pTimeOffset,
		HIObject	pObject = `NULL`
	)

Constructor.

Parameters

pFilePath	Media file path to create clip with.
pTrack	The track in which we create the clip.
pTime	Time where the clip should begin.
pTimeOffset	Time offset where the clip should begin.
pObject	For internal use only.

Member Function Documentation

◆ CanAssignSourcesToDestinations()

bool CanAssignSourcesToDestinations ( )

CanAssignSourcesToDestinations.

Determines if the animation clip can assign its sources to some destinations or not.

Returns: Returns true if the animation clip can assign its sources to some destinations, false otherwise.

◆ Clone()

FBStoryClip * Clone ( )

Clone the clip.

◆ DestinationSetObject()

bool DestinationSetObject	(	const char *	pSrcName,
		FBComponent *	pObject
	)

Assign source to destination if the pSrcName is found in source list and pObject is in the Details list.

Parameters

pSrcName	The name of the source.
pObject	The destination object.

Returns: Returns true if assignment has been executed when the pSrcName is found in source list and pObject is in the Details list.

Remarks: Assignment success depends on if they have the same name property and with animation on the source property.

◆ ExportToFile()

bool ExportToFile ( FBString pOutputFile )

ExportToFile.

Export animation clip to disk file.

Parameters

pOutputFile Output file path name.

Returns: Returns true if successful.

◆ FBDelete()

virtual void FBDelete ( )

overridevirtual

Virtual FBDelete function.

Reimplemented from FBComponent.

◆ GetAffectedAnimationNodes()

void GetAffectedAnimationNodes	(	FBArrayTemplate< FBAnimationNode * > *	pAffectedAnimationNodes,
		FBComponent *	pClipObject
	)

GetAffectedAnimationNodes.

Get the list of animation nodes affected by this story clip, for a specific object.

Python: The function takes only one parameter (pClipObject) and returns a Python list. ex : lArray = lClip.GetAffectedAnimationNodes(lObject)

Parameters

pAffectedAnimationNodes	Array of affected animation nodes, will be filled by the function.
pClipObject	The object for which we search for affected animation nodes.

◆ GetAffectedObjects()

void GetAffectedObjects ( FBArrayTemplate< FBComponent * > * pAffectedObjects )

GetAffectedObjects.

Get the list of objects affected by this story clip.

Python: The function takes no parameter and returns a Python list. ex : lArray = lClip.GetAffectedObjects()

Parameters

pAffectedObjects Array of affected objects, will be filled by the function.

◆ GetAssignSourcesToDestinationsInfo() [1/2]

void GetAssignSourcesToDestinationsInfo	(	FBStringList &	pSrcList,
		FBArrayBool &	pValidAnimatedSrc,
		FBStringList &	pAvailableDstList,
		FBArrayBool &	pValidAnimatedDst,
		FBStringList &	pDefaultDstList,
		FBStringList &	pEffectiveDstList
	)

GetAssignSourcesToDestinationsInfo.

Returns the information about the current state of Sources to Destinations assignment. The pSrcList, pValidAnimatedSrc, pDefaultDstList & pEffectiveDstList parameters will all be of the same size, each index being related to the same index in the other lists/array. The pAvailableDstList & pValidAnimatedDst parameters can contain more items than the other lists. Both will all be of the same size, each index being related to the same index in the other list/array.

Parameters

pSrcList	(C++ only) String list containing all the sources, will be filled by the method.
pValidAnimatedSrc	(C++ only) Array of bool containing the animated validity state of the sources, will be filled by the method.
pAvailableDstList	(C++ only) String list containing all the available destinations, will be filled by the method.
pValidAnimatedDst	(C++ only) Array of bool containing the animated validity state of the available destinations, will be filled by the method.
pDefaultDstList	(C++ only) String list containing the default destinations (contains each string item that will be put back when pressing the 'Reset' button in the UI), will be filled by the method.
pEffectiveDstList	(C++ only) String list containing the effective destination (destinations currently active), will be filled by the method.

Returns: (Python only) A tuple with 6 values: (pSrcList, pValidAnimatedSrc, pAvailableDstList, pValidAnimatedDst, pDefaultDstList, pEffectiveDstList).

◆ GetAssignSourcesToDestinationsInfo() [2/2]

K_DEPRECATED_2023 void GetAssignSourcesToDestinationsInfo	(	FBStringList &	pSrcList,
		FBStringList &	pAvailableDstList,
		FBStringList &	pDefaultDstList,
		FBStringList &	pEffectiveDstList
	)

GetAssignSourcesToDestinationsInfo.

Returns the information about the current state of Sources to Destinations assignment. The pSrcList, pDefaultDstList & pEffectiveDstList parameters will all be of same size, each index being related to the same index in the other lists. The pAvailableDstList parameter can contains more item than the other lists.

Deprecated:: Use the other signature. (For Python, use the GetAssignSourcesToDestinationsInfoEx method instead.)

Parameters

pSrcList	String list containing all the sources, will be filled by the method.
pAvailableDstList	String list containing all the available destinations, will be filled by the method.
pDefaultDstList	String list containing the default destinations (contains each string item that will be put back when pressing the 'Reset' button in the UI), will be filled by the method.
pEffectiveDstList	String list containing the effective destination (destinations currently active), will be filled by the method.

◆ GetFbxScene()

fbxsdk::FbxScene * GetFbxScene ( )

Get KFbxScene.

Will only return valid pointer to KFbxScene for readonly animation clip.

◆ GetReadOnly()

bool GetReadOnly ( )

GetReadOnly Retrieves the clip read-only status.

Returns: Returns the clip read-only status.

◆ GetSourceTimeFromDestinationTime()

FBTime GetSourceTimeFromDestinationTime	(	FBTime	pDestinationTime,
		int *	pLoopNumber = `nullptr`
	)

Get the clip source time (internal time) from a destination time (local time).

Python: The function takes only one parameter (pDestinationTime) and returns a Python tuple: (sourceTime, loopNumber). ex : lTuple = lClip.GetSourceTimeFromDestinationTime(lDestinationTime)

Parameters

pDestinationTime	The destination time to convert.
pLoopNumber	The number of loops applied on the source time to match the destination time to convert. Optional. Will be filled by the method.

Returns: The clip source time matching the input destination time.

◆ MakeWritable()

bool MakeWritable ( )

MakeWritable.

Imports FCurves from story clip scene making them accessible for the user.

Returns: Returns true if successful.

◆ Match() [1/2]

void Match ( )

Match.

Match the animation clip with the specified pivot property.

◆ Match() [2/2]

void Match	(	FBString	pObjectName,
		FBStoryClipMatchingTimeType	pTimeType,
		FBStoryClipMatchingTranslationType	pTranslationType,
		FBStoryClipMatchingRotationType	pRotationType
	)

Match.

Match the animation clip to its previous/next animation clip, one to each other.

Parameters

pObjectName	The object name that specifies which part of the track content to use to match clips. If the object name is not valid, or empty, the match object will be disabled so that the blend does not take it into account when matching clips.
pTimeType	The time type specifying which point of a cross-blend the selected clip is matched.
pTranslationType	The translation type specifying if/how a clip's match object is translated to match another clip's animation.
pRotationType	The rotation type specifying if/how a clip's match object is rotated to match another clip's animation.

◆ Move()

FBTime Move	(	FBTime	pDelta,
		bool	pForce = `true`
	)

Move.

Move the clip of a delta offset.

Parameters

pDelta	Delta time to apply to the clip.
pForce	Force clip to find the nearest position if the move fail.

Returns: Return the delta between the new and previous clip's position.

◆ MoveTo()

FBTime MoveTo	(	FBTime	pTime,
		bool	pForce = `true`
	)

MoveTo.

Move the clip to the specified time.

Parameters

pTime	Time where to put the clip.
pForce	Force clip to find the nearest position if the move fail.

Returns: Returns the new clip's time position.

◆ Razor()

FBStoryClip * Razor ( FBTime pTime )

Razor.

Cut (razor) the clip at the specified time.

Parameters

pTime Time where to cut. This time is local to the track, not to the clip.

Returns: Returns the new clip generated by the razor action (right part).

◆ SetAssignSourcesToDestinationsInfo()

bool SetAssignSourcesToDestinationsInfo ( FBStringList & pEffectiveDstList )

SetAssignSourcesToDestinationsInfo.

Sets the new effective destinations information for the Sources to Destinations assignment. The input string list size must contain the same number of items than the effective destination list returned by the GetAssignSourcesToDestinationsInfo method. Each item in the input string list must match an item in the available destination list returned by the GetAssignSourcesToDestinationsInfo method. The item at a given index of the input string list will be related to the same index of the sources list returned by the GetAssignSourcesToDestinationsInfo method.

Parameters

pEffectiveDstList String list containing the new effective destination.

Returns: Returns true if the assign succeeded, false otherwise.

◆ SetReadOnly()

bool SetReadOnly	(	bool	pMakeClipReadOnly,
		FBString	pOutputFile = `FBString()`
	)

SetReadOnly Assigns the clip read-only status.

Parameters

pMakeClipReadOnly	New read-only status
pOutputFile	Output file path name, when setting the clip's read-only status to true.

Returns: Returns true if successful.

◆ SetTime()

void SetTime	(	FBTime *	pSourceIn = `NULL`,
		FBTime *	pSourceOut = `NULL`,
		FBTime *	pDestinationIn = `NULL`,
		FBTime *	pDestinationOut = `NULL`,
		bool	pUseAlternateSrcInProp = `false`
	)

SetTime Sets any in/out values for the source/destination times.

In and out values are optional and the current values for the story clip will be used if not supplied. The story "Speed" property will be adjusted in order for the supplied values to be respected by the story clip.

Parameters

pSourceIn	New value for the source IN time. Passing a value will modify the "FirstLoopMarkIn" and/or the "Speed" properties.
pSourceOut	New value for the source OUT time. Passing a value will modify the "LastLoopMarkOut" and/or the "Speed" properties.
pDestinationIn	New value for the destination IN time. Passing a value will modify the "Stop" and/or the "Speed" properties.
pDestinationOut	New value for the destination OUT time. Passing a value will modify the "Start" and/or the "Speed" properties.
pUseAlternateSrcInProp	Will work on the "SourceMarkIn" property instead of the "FirstLoopMarkIn" property when passing pSourceIn.

◆ UpdateFromCurrentTake()

bool UpdateFromCurrentTake ( )

Update clip animation from current take animation for clip track's scope, works only for clip created by Insert Current Take and connected to current take.

Returns: Returns true if succeed.

Member Data Documentation

◆ AudioClip

FBPropertyAudioClip AudioClip

Read Only Property: The audio clip used by this StoryClip.

Definition at line 1058 of file fbstory.h.

◆ AutoLoop

FBPropertyBool AutoLoop

Read Write Property: If true, clip will automatically loop

Definition at line 1076 of file fbstory.h.

◆ ClipAnimationPath

FBPropertyString ClipAnimationPath

Read Write Property: Animation clip's file path

Definition at line 1071 of file fbstory.h.

◆ ClipAudioPath

FBPropertyString ClipAudioPath

Read Write Property: Audio clip's file path

Definition at line 1059 of file fbstory.h.

◆ ClipPitch

FBPropertyDouble ClipPitch

Read Write Property: The clip pitch value.

Definition at line 1060 of file fbstory.h.

◆ ClipVideoPath

FBPropertyString ClipVideoPath

Read Write Property: Video clip's file path

Definition at line 1064 of file fbstory.h.

◆ Color

FBPropertyColor Color

Read Write Property: Color of the clip.

Definition at line 1032 of file fbstory.h.

◆ ConnectedToTake

FBPropertyBool ConnectedToTake

Read Write Property: When connected to current take, user can do updating from current take, but user can't edit clip animation by adding keys, only works for clips created by Insert Current Take.

Definition at line 1093 of file fbstory.h.

◆ CustomTimeWarp

FBPropertyAnimationNode CustomTimeWarp

Read Only Property: Animation and Shot clip's custom TimeWarp FCurve.

Definition at line 1106 of file fbstory.h.

◆ FirstLoopMarkIn

FBPropertyTime FirstLoopMarkIn

Read Write Property: For a read-only clip, the start time inside the clip for its first loop. For a writable clip, use the SourceMarkIn property instead.

Definition at line 1037 of file fbstory.h.

◆ FrameRate

FBPropertyDouble FrameRate

Read Write Property: Frame rate value. Only effective when UseSystemFrameRate is false.

Definition at line 1067 of file fbstory.h.

◆ Ghost

FBPropertyBool Ghost

Read Write Property: Show ghosts

Definition at line 1078 of file fbstory.h.

◆ GhostCustomTime

FBPropertyTime GhostCustomTime

Read Write Property: Custom time to display ghost, only applicable if ShowGhostClipMode is kFBStoryClipTimeCustom.

Definition at line 1083 of file fbstory.h.

◆ GhostManipulatorCustomTime

FBPropertyTime GhostManipulatorCustomTime

Read Write Property: Custom time to display ghost manipulator, only applicable if GhostManipulatorMode is kFBStoryClipGhostCustom.

Definition at line 1092 of file fbstory.h.

◆ GhostManipulatorMode

FBPropertyStoryClipGhostTimeMode GhostManipulatorMode

Read Write Property: Time mode to display ghost manipulator. See FBStoryClipGhostTimeMode.

Definition at line 1091 of file fbstory.h.

◆ GhostManipulatorOffset

FBPropertyVector3d GhostManipulatorOffset

Read Write Property: Animation clip's ghost manipulator offset.

Definition at line 1088 of file fbstory.h.

◆ GhostModel

FBPropertyBool GhostModel

Read Write Property: Show ghost of models

Definition at line 1079 of file fbstory.h.

◆ GhostPivot

FBPropertyBool GhostPivot

Read Write Property: Show ghost of match object

Definition at line 1081 of file fbstory.h.

◆ GhostTravelling

FBPropertyBool GhostTravelling

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

Definition at line 1080 of file fbstory.h.

◆ ImageSequence

FBPropertyBool ImageSequence

Read Write Property: Whether is a image sequence.

Definition at line 1065 of file fbstory.h.

◆ LastLoopMarkOut

FBPropertyTime LastLoopMarkOut

Read Write Property: For a read-only clip, the end time inside the clip for its last loop. For a writable clip, use the Stop property instead.

Definition at line 1038 of file fbstory.h.

◆ Loaded

FBPropertyBool Loaded

Read Write Property: If true, clip file is loaded into memory and can be evaluated (will affect track content).

Definition at line 1087 of file fbstory.h.

◆ LockPitchToSpeed

FBPropertyBool LockPitchToSpeed

Read Write Property: Time-stretching enabled or not.

Definition at line 1061 of file fbstory.h.

◆ Loop

FBPropertyBool Loop

Read Write Property: If true, loop clip's animation

Definition at line 1077 of file fbstory.h.

◆ LoopTranslation

FBPropertyVector3d LoopTranslation

Read Write Property: Animation clip's loop translation.

Definition at line 1075 of file fbstory.h.

◆ MarkIn

K_DEPRECATED_2026 FBPropertyTime MarkIn

Read Write Property: Start time inside the clip.

Deprecated:: Use the FBStoryClip.FirstLoopMarkIn property instead.

Definition at line 1035 of file fbstory.h.

◆ MarkOut

K_DEPRECATED_2026 FBPropertyTime MarkOut

Read Write Property: Stop time inside the clip.

Deprecated:: Use the FBStoryClip.LastLoopMarkOut property instead.

Definition at line 1036 of file fbstory.h.

◆ MirrorAnimation

FBPropertyBool MirrorAnimation

Read Write Property: If true, clip animation will be mirrored

Definition at line 1097 of file fbstory.h.

◆ MirrorPlane

FBPropertyStoryClipMirrorPlane MirrorPlane

Read Write Property: Several mirror planes to mirror animation. See FBStoryClipMirrorPlane

Definition at line 1098 of file fbstory.h.

◆ Offset

FBPropertyTime Offset

Read Write Property: First loop time offset.

Definition at line 1043 of file fbstory.h.

◆ OnChange

FBPropertyEvent OnChange

Event: Something in the clip has changed. (FBEventClip)

Definition at line 1100 of file fbstory.h.

◆ Pivots

FBPropertyListPivot Pivots

List: Pivots models (Generally, only one model is necessary)

Definition at line 1086 of file fbstory.h.

◆ PostBlend

FBPropertyTimeSpan PostBlend

Read Write Property: Start/Stop time of the post-blend phase.

Definition at line 1042 of file fbstory.h.

◆ PostBlendData

FBPropertyAnimationNode PostBlendData

Read Only Property: To get the animation of the Post blend curve

Definition at line 1085 of file fbstory.h.

◆ PreBlend

FBPropertyTimeSpan PreBlend

Read Write Property: Start/Stop time of the pre-blend phase.

Definition at line 1041 of file fbstory.h.

◆ PreBlendData

FBPropertyAnimationNode PreBlendData

Read Only Property: To get the animation of the Pre blend curve

Definition at line 1084 of file fbstory.h.

◆ Rotation

FBPropertyVector3d Rotation

Read Write Property: Animation clip's rotation offset. Refer to class notes to learn more about how this is applied.

Definition at line 1074 of file fbstory.h.

◆ Scale

FBPropertyDouble Scale

Read Write Property: Animation clip's scaling (some don't support this property)

Definition at line 1072 of file fbstory.h.

◆ ShotActionStart

FBPropertyTime ShotActionStart

Read Write Property: If not in locked shot mode (time discontinuity enabled), this time can be different from the Clip->Start property.

Definition at line 1053 of file fbstory.h.

◆ ShotActionStop

FBPropertyTime ShotActionStop

Read Write Property: If not in locked shot mode (time discontinuity enabled), this time can be different from the Clip->Start property.

Definition at line 1054 of file fbstory.h.

◆ ShotBackplate

FBPropertyVideo ShotBackplate

Read Write Property: The backplate used for that specific shot.

Definition at line 1049 of file fbstory.h.

◆ ShotCamera

FBPropertyCamera ShotCamera

Read Write Property: The camera used for that specific shot.

Definition at line 1048 of file fbstory.h.

◆ ShotFrontplate

FBPropertyVideo ShotFrontplate

Read Write Property: The frontplate used for that specific shot.

Definition at line 1050 of file fbstory.h.

◆ ShotStartStopLocked

FBPropertyBool ShotStartStopLocked

Read Write Property: Shot clip's 'In/Out Locked' property value. True if the shot clip's In/Out properties (start/stop times of the clip local to its track) are locked, false otherwise.

Definition at line 1055 of file fbstory.h.

◆ ShowBackplate

FBPropertyBool ShowBackplate

Read Write Property: Enable/Disable the shot backplate.

Definition at line 1051 of file fbstory.h.

◆ ShowEmbeddedTimecode

K_DEPRECATED_2024 FBPropertyBool ShowEmbeddedTimecode

Read Write Property: Whether to show the embedded timecode (real, if available, or custom) of the video.

Deprecated:: Use the FBVideoClip.ShowEmbeddedTimecode property instead.

Definition at line 1068 of file fbstory.h.

◆ ShowFrontplate

FBPropertyBool ShowFrontplate

Read Write Property: Enable/Disable the shot frontplate.

Definition at line 1052 of file fbstory.h.

◆ ShowGhostClipMode

FBPropertyStoryClipShowGhostMode ShowGhostClipMode

Read Write Property: Show the ghost depending on the time. See FBStoryClipShowGhostMode

Definition at line 1082 of file fbstory.h.

◆ SolvingMode

FBPropertyStoryClipSolveMode SolvingMode

Read Write Property: Solve Modes for story character clips. See FBStoryClipSolveMode

Definition at line 1096 of file fbstory.h.

◆ SourceMarkIn

FBPropertyTime SourceMarkIn

Read Write Property: For a read-only clip, the start time inside the clip for all the loops except its first loop. For a writable clip, the start time inside the clip.

Definition at line 1039 of file fbstory.h.

◆ SourceMarkOut

FBPropertyTime SourceMarkOut

Read Write Property: For a read-only clip, the stop time inside the clip for all the loops except its last loop. For a writable clip, use the Stop property instead.

Definition at line 1040 of file fbstory.h.

◆ Speed

FBPropertyDouble Speed

Read Write Property: Speed of the clip.

Definition at line 1044 of file fbstory.h.

◆ Start

FBPropertyTime Start

Read Write Property: Start time of the clip local to its track.

Definition at line 1033 of file fbstory.h.

◆ StartStopLocked

FBPropertyBool StartStopLocked

Read Write Property: Clip's 'In/Out Locked' property value. True if the clip's In/Out properties (start/stop times of the clip local to its track) are locked, false otherwise.

Definition at line 1045 of file fbstory.h.

◆ Stop

FBPropertyTime Stop

Read Write Property: Stop time of the clip local to its track.

Definition at line 1034 of file fbstory.h.

◆ TimeWarpEnabled

FBPropertyBool TimeWarpEnabled

Read Write Property: Animation and Shot clip's TimeWarp activeness.

Definition at line 1103 of file fbstory.h.

◆ TimeWarpInterpolatorType

FBPropertyStoryClipTimeWarpInterpolatorType TimeWarpInterpolatorType

Read Write Property: Animation and Shot clip's TimeWarp interpolation type. See FBStoryClipTimeWarpInterpolatorType.

Definition at line 1104 of file fbstory.h.

◆ TimeWarpReverse

FBPropertyBool TimeWarpReverse

Read Write Property: If true, reverse the Animation or Shot clip's TimeWarp FCurve.

Definition at line 1105 of file fbstory.h.

◆ Translation

FBPropertyVector3d Translation

Read Write Property: Animation clip's translation offset. Refer to class notes to learn more about how this is applied.

Definition at line 1073 of file fbstory.h.

◆ TravellingNode

FBPropertyListObject TravellingNode

List: Travelling node(s). If set, this property will overwrite the Track's Travelling node(s).

Definition at line 1089 of file fbstory.h.

◆ TravellingNodeFunction

FBPropertyStoryClipNodeFunction TravellingNodeFunction

Read Write Property: Travelling node function. If set, this property will overwrite the Track's Travelling node function. See FBStoryClipNodeFunction.

Definition at line 1090 of file fbstory.h.

◆ UseSystemFrameRate

FBPropertyBool UseSystemFrameRate

Read Write Property: Whether always use system frame rate.

Definition at line 1066 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

◆ FBStoryClip() [1/3]

◆ FBStoryClip() [2/3]

◆ FBStoryClip() [3/3]

Member Function Documentation

◆ CanAssignSourcesToDestinations()

◆ Clone()

◆ DestinationSetObject()

◆ ExportToFile()

◆ FBDelete()

◆ GetAffectedAnimationNodes()

◆ GetAffectedObjects()

◆ GetAssignSourcesToDestinationsInfo() [1/2]

◆ GetAssignSourcesToDestinationsInfo() [2/2]

◆ GetFbxScene()

◆ GetReadOnly()

◆ GetSourceTimeFromDestinationTime()

◆ MakeWritable()

◆ Match() [1/2]

◆ Match() [2/2]

◆ Move()

◆ MoveTo()

◆ Razor()

◆ SetAssignSourcesToDestinationsInfo()

◆ SetReadOnly()

◆ SetTime()

◆ UpdateFromCurrentTake()

Member Data Documentation

◆ AudioClip

◆ AutoLoop

◆ ClipAnimationPath

◆ ClipAudioPath

◆ ClipPitch

◆ ClipVideoPath

◆ Color

◆ ConnectedToTake

◆ CustomTimeWarp

◆ FirstLoopMarkIn

◆ FrameRate

◆ Ghost

◆ GhostCustomTime

◆ GhostManipulatorCustomTime

◆ GhostManipulatorMode

◆ GhostManipulatorOffset

◆ GhostModel

◆ GhostPivot

◆ GhostTravelling

◆ ImageSequence

◆ LastLoopMarkOut

◆ Loaded

◆ LockPitchToSpeed

◆ Loop

◆ LoopTranslation

◆ MarkIn

◆ MarkOut

◆ MirrorAnimation

◆ MirrorPlane

◆ Offset

◆ OnChange

◆ Pivots

◆ PostBlend

◆ PostBlendData

◆ PreBlend

◆ PreBlendData

◆ Rotation

◆ Scale

◆ ShotActionStart

◆ ShotActionStop

◆ ShotBackplate

◆ ShotCamera

◆ ShotFrontplate

◆ ShotStartStopLocked

◆ ShowBackplate

◆ ShowEmbeddedTimecode

◆ ShowFrontplate

◆ ShowGhostClipMode