Time Warp Manager Interface to the Time Warp Manager. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBTimeWarpManager:

[legend]

Public Member Functions
	FBTimeWarpManager ()
	Constructor.

bool	ApplyTimeWarp (FBTake pTake, FBProperty pEvalProp, FBAnimationNode pTimeWarp)
	Apply the TimeWarp in a Take to an evaluation property, just connect the storing property for the TimeWarp to the evaluation property.

K_DEPRECATED_2023 void	DestroyTimeWarpFromTake (FBTake pTake, FBAnimationNode pTimeWarp)
	Destroy the TimeWarp in a Take, and removed from the DataSet.

int	FindTimeWarpNickNumberGlobal (FBAnimationNode pTimeWarp)
	Find the Nick Number of one timewarp globally.

FBAnimationNode	GetTimeWarpAtIndex (FBTake pTake, kLong pIndex)
	Get the TimeWarp in a Take At specific Index.

kLong	GetTimeWarpCount (FBTake pTake)
	Get the count of TimeWarp in a Take.

FBAnimationNode	GetTimeWarpFromNickNumber (FBTake pTake, int pNumber)
	Get the timeWarp of specific Nick Number in a Take.

int	GetTimeWarpNickNumber (FBTake pTake, FBAnimationNode pTimeWarp)
	Get the Nick Number of one TimeWarp in a Take.

int	GetTimeWarpNickNumberAtIndex (FBTake pTake, kLong pIndex)
	Get the Nick Number of one TimeWarp At specific index in a Take.

	RemoveTimeWarp (FBTake pTake, FBProperty pEvalProp)
	Undo apply a timeWarp in a Take to an evaluation property, just disconnect the evaluation property from storing property.

K_DEPRECATED_2023 void	RemoveTimeWarpFromScene (FBAnimationNode pTimeWarp)
	Remove a TimeWarp from Scene.

	RemoveTimeWarpFromScene (FBTake pTake, FBAnimationNode pTimeWarp)
	Remove the given TimeWarp from scene and delete it from the given Take.

bool	SetTimeWarpNickNumber (FBTake pTake, FBAnimationNode pTimeWarp, int pNumber)
	Set the Nick Number of one TimeWarp in a Take.

	TimeWarpAddToTake (FBTake pTake, FBAnimationNode pTimeWarp, int pNickNumber=0)
	Add one TimeWarp to a Take.

	TimeWarpClearTake (FBTake pTake)
	Clear all TimeWarp in a Take, and removed from the DataSet.

	TimeWarpCopyTake (FBTake pDstTake, FBTake pSrcTake)
	Copy all the TimeWarp in one Take, add to another Take.

FBAnimationNode	TimeWarpCreateNew (str pName)
	Create a TimeWarp with a specific name on the current Take.

	TimeWarpInitTake (FBTake pTake)
	Allocate container for the TimeWarp in one Take.

	TimeWarpMergeCurveNode (FBTake pTake, FBProperty pEvalProp, FBAnimationNode pNode, FBAnimationNode pTimeWarpNode)
	Merge the TimeWarp to a function curve, and Remove the connection between the storing property and the evaluation property for the TimeWarp.

	TimeWarpRename (FBTake pTake, FBAnimationNode pTimeWarp, str pNewName)
	Rename a TimeWarp.

	TimeWarpTakeChange ()
	Call registered callbacks when changes related to TimeWarp happen.

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.

Additional Inherited Members
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

Time Warp Manager Interface to the Time Warp Manager.

See sample: TimeWarp.py.

Constructor & Destructor Documentation

◆ FBTimeWarpManager()

FBTimeWarpManager ( )

Constructor.

Note: protect

Member Function Documentation

◆ ApplyTimeWarp()

bool ApplyTimeWarp	(	FBTake	pTake,
		FBProperty	pEvalProp,
		FBAnimationNode	pTimeWarp
	)

Apply the TimeWarp in a Take to an evaluation property, just connect the storing property for the TimeWarp to the evaluation property.

Parameters

pTake	The Take where the TimeWarp in.
pEvalProp	The evaluation property to be applied on.
pTimeWarp	The TimeWarp to apply.

Returns: True if apply successfully.

◆ DestroyTimeWarpFromTake()

K_DEPRECATED_2023 void DestroyTimeWarpFromTake	(	FBTake	pTake,
		FBAnimationNode	pTimeWarp
	)

Destroy the TimeWarp in a Take, and removed from the DataSet.

This one should be called after calling the RemoveTimeWarpFromScene method (the one with one parameter).

Parameters

pTake	The Take where the TimeWarp in.
pTimeWarp	The TimeWarp to be Destroyed.

◆ FindTimeWarpNickNumberGlobal()

int FindTimeWarpNickNumberGlobal ( FBAnimationNode pTimeWarp )

Find the Nick Number of one timewarp globally.

Parameters

pTimeWarp The TimeWarp queried.

Returns: the Nick Number of the timewarp.

◆ GetTimeWarpAtIndex()

FBAnimationNode GetTimeWarpAtIndex	(	FBTake	pTake,
		kLong	pIndex
	)

Get the TimeWarp in a Take At specific Index.

Parameters

pTake	The Take queried.
pIndex	The index of the TimeWarp.

Returns: TimeWarp at specific Index in a Take.

◆ GetTimeWarpCount()

kLong GetTimeWarpCount ( FBTake pTake )

Get the count of TimeWarp in a Take.

Parameters

pTake The Take queried.

Returns: the TimeWarp count.

◆ GetTimeWarpFromNickNumber()

FBAnimationNode GetTimeWarpFromNickNumber	(	FBTake	pTake,
		int	pNumber
	)

Get the timeWarp of specific Nick Number in a Take.

Parameters

pTake	The Take queried.
pNumber	the Nick Number of one TimeWarp.

Returns: the TimeWarp of specific Nick Number.

◆ GetTimeWarpNickNumber()

int GetTimeWarpNickNumber	(	FBTake	pTake,
		FBAnimationNode	pTimeWarp
	)

Get the Nick Number of one TimeWarp in a Take.

Parameters

pTake	The Take queried.
pTimeWarp	The TimeWarp queried.

Returns: the Nick Number of one TimeWarp.

◆ GetTimeWarpNickNumberAtIndex()

int GetTimeWarpNickNumberAtIndex	(	FBTake	pTake,
		kLong	pIndex
	)

Get the Nick Number of one TimeWarp At specific index in a Take.

Parameters

pTake	The Take queried.
pIndex	The index a TimeWarp at.

Returns: the Nick Number of one TimeWarp At specific index.

◆ RemoveTimeWarp()

RemoveTimeWarp	(	FBTake	pTake,
		FBProperty	pEvalProp
	)

Undo apply a timeWarp in a Take to an evaluation property, just disconnect the evaluation property from storing property.

Parameters

pTake	The Take where the TimeWarp evaluation property connected is in.
pEvalProp	The evaluation property connected a TimeWarp in the storing property of one take.

◆ RemoveTimeWarpFromScene() [1/2]

K_DEPRECATED_2023 void RemoveTimeWarpFromScene ( FBAnimationNode pTimeWarp )

Remove a TimeWarp from Scene.

Any locked properties affected by this TimeWarp will be modified as well.

Parameters

pTimeWarp The TimeWarp to be Removed.

◆ RemoveTimeWarpFromScene() [2/2]

RemoveTimeWarpFromScene	(	FBTake	pTake,
		FBAnimationNode	pTimeWarp
	)

Remove the given TimeWarp from scene and delete it from the given Take.

Any locked properties affected by this TimeWarp will be modified as well.

Parameters

pTake	The Take where the TimeWarp is in.
pTimeWarp	The TimeWarp to be removed and deleted.

◆ SetTimeWarpNickNumber()

bool SetTimeWarpNickNumber	(	FBTake	pTake,
		FBAnimationNode	pTimeWarp,
		int	pNumber
	)

Set the Nick Number of one TimeWarp in a Take.

Parameters

pTake	The Take specific.
pTimeWarp	The TimeWarp specific.
pNumber	The Nick Number to set.

Returns: True if set successfully.

◆ TimeWarpAddToTake()

TimeWarpAddToTake	(	FBTake	pTake,
		FBAnimationNode	pTimeWarp,
		int	pNickNumber = `0`
	)

Add one TimeWarp to a Take.

Parameters

pTake	The Take one TimeWarp added to.
pTimeWarp	The TimeWarp to be added.
pNickNumber	The Nick Number for the TimeWarp.

◆ TimeWarpClearTake()

TimeWarpClearTake ( FBTake pTake )

Clear all TimeWarp in a Take, and removed from the DataSet.

Parameters

pTake The Take to be cleared.

◆ TimeWarpCopyTake()

TimeWarpCopyTake	(	FBTake	pDstTake,
		FBTake	pSrcTake
	)

Copy all the TimeWarp in one Take, add to another Take.

Parameters

pDstTake	Copy all TimeWarp to.
pSrcTake	Copy all TimeWarp from.

◆ TimeWarpCreateNew()

FBAnimationNode TimeWarpCreateNew ( str pName )

Create a TimeWarp with a specific name on the current Take.

Parameters

pName The name for the TimeWarp.

Returns: the TimeWarp created.

◆ TimeWarpInitTake()

TimeWarpInitTake ( FBTake pTake )

Allocate container for the TimeWarp in one Take.

Parameters

pTake The Take allocated for.

◆ TimeWarpMergeCurveNode()

TimeWarpMergeCurveNode	(	FBTake	pTake,
		FBProperty	pEvalProp,
		FBAnimationNode	pNode,
		FBAnimationNode	pTimeWarpNode
	)

Merge the TimeWarp to a function curve, and Remove the connection between the storing property and the evaluation property for the TimeWarp.

Parameters

pTake	The Take that the TimeWarp is in.
pEvalProp	the evaluation property the TimeWarp connected.
pNode	The function curve to merge on.
pTimeWarpNode	The TimeWarp to be merged.

◆ TimeWarpRename()

TimeWarpRename	(	FBTake	pTake,
		FBAnimationNode	pTimeWarp,
		str	pNewName
	)

Rename a TimeWarp.

Parameters

pTake	The Take where the timeWarp is in.
pTimeWarp	The TimeWarp to be renamed.
pNewName	The new name for the TimeWarp.

◆ TimeWarpTakeChange()

TimeWarpTakeChange ( )

Call registered callbacks when changes related to TimeWarp happen.

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBTimeWarpManager()

Member Function Documentation

◆ ApplyTimeWarp()

◆ DestroyTimeWarpFromTake()

◆ FindTimeWarpNickNumberGlobal()

◆ GetTimeWarpAtIndex()

◆ GetTimeWarpCount()

◆ GetTimeWarpFromNickNumber()

◆ GetTimeWarpNickNumber()

◆ GetTimeWarpNickNumberAtIndex()

◆ RemoveTimeWarp()

◆ RemoveTimeWarpFromScene() [1/2]

◆ RemoveTimeWarpFromScene() [2/2]

◆ SetTimeWarpNickNumber()

◆ TimeWarpAddToTake()

◆ TimeWarpClearTake()

◆ TimeWarpCopyTake()

◆ TimeWarpCreateNew()

◆ TimeWarpInitTake()

◆ TimeWarpMergeCurveNode()

◆ TimeWarpRename()

◆ TimeWarpTakeChange()