Detailed Description

Time Warp Manager Interface to the Time Warp Manager.

Examples: Samples/FCurve/TimeWarp.py

Inheritance diagram for FBTimeWarpManager:

Public Member Functions
	__init__ ()
	Constructor.
	TimeWarpTakeChange ()
	Call registered callbacks when changes related to TimeWarp happen.
	TimeWarpClearTake (HFBTake pTake)
	Clear all TimeWarp in a Take, and removed from the DataSet.
	TimeWarpInitTake (HFBTake pTake)
	Allocate container for the TimeWarp in one Take.
	TimeWarpCopyTake (HFBTake pDstTake, HFBTake pSrcTake)
	Copy all the TimeWarp in one Take, add to another Take.
	TimeWarpAddToTake (HFBTake pTake, FBAnimationNode pTimeWarp, int pNickNumber=0)
	Add one TimeWarp to a Take.
	DestroyTimeWarpFromTake (HFBTake pTake, FBAnimationNode pTimeWarp)
	Destroy the TimeWarp in a Take, and removed from the DataSet.
	RemoveTimeWarpFromScene (FBAnimationNode pTimeWarp)
	Remove a TimeWarp from Scene.
long	GetTimeWarpCount (HFBTake pTake)
	Get the count of TimeWarp in a Take.
FBAnimationNode	GetTimeWarpAtIndex (HFBTake pTake, long pIndex)
	Get the TimeWarp in a Take At specific Index.
int	GetTimeWarpNickNumber (HFBTake pTake, FBAnimationNode pTimeWarp)
	Get the Nick Number of one TimeWarp in a Take.
bool	SetTimeWarpNickNumber (HFBTake pTake, FBAnimationNode pTimeWarp, int pNumber)
	Set the Nick Number of one TimeWarp in a Take.
int	GetTimeWarpNickNumberAtIndex (HFBTake pTake, long pIndex)
	Get the Nick Number of one TimeWarp At specific index in a Take.
FBAnimationNode	GetTimeWarpFromNickNumber (HFBTake pTake, int pNumber)
	Get the timeWarp of specific Nick Number in a Take.
int	FindTimeWarpNickNumberGlobal (FBAnimationNode pTimeWarp)
	Find the Nick Number of one timewarp globally.
bool	ApplyTimeWarp (HFBTake 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.
	RemoveTimeWarp (HFBTake pTake, FBProperty pEvalProp)
	Undo apply a timeWarp in a Take to an evaluation property, just disconnect the evaluation property from storing property.
	TimeWarpRegisterChangeEvent (TimeWarpChangeCallback pCallback, pObject)
	Register a callback Called when some changes related to TimeWarp happen.
	TimeWarpUnregisterChangeEvent (TimeWarpChangeCallback pCallback, pObject)
	Unregister a call registered.
FBAnimationNode	TimeWarpCreateNew (str pName)
	Create a TimeWarp with a specific name.
	TimeWarpRename (HFBTake pTake, FBAnimationNode pTimeWarp, str pNewName)
	Rename a TimeWarp.
	TimeWarpMergeCurveNode (HFBTake 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.
FBTimeWarpManager	TheOne ()
	Get the global object for this class.

Member Function Documentation

__init__ ( )

Search for all occurrences

Constructor.

protect

Examples: Samples/FCurve/TimeWarp.py

TimeWarpTakeChange ( )

Search for all occurrences

Call registered callbacks when changes related to TimeWarp happen.

TimeWarpClearTake ( HFBTake pTake )

Search for all occurrences

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

Parameters:

pTake The Take to be cleared.

TimeWarpInitTake ( HFBTake pTake )

Search for all occurrences

Allocate container for the TimeWarp in one Take.

Parameters:

pTake The Take allocated for.

TimeWarpCopyTake	(	HFBTake	pDstTake,
		HFBTake	pSrcTake
	)

Search for all occurrences

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

Parameters:

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

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

Search for all occurrences

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.

DestroyTimeWarpFromTake	(	HFBTake	pTake,
		FBAnimationNode	pTimeWarp
	)

Search for all occurrences

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

Parameters:

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

RemoveTimeWarpFromScene ( FBAnimationNode pTimeWarp )

Search for all occurrences

Remove a TimeWarp from Scene.

Parameters:

pTimeWarp The TimeWarp to be Removed.

long GetTimeWarpCount ( HFBTake pTake )

Search for all occurrences

Get the count of TimeWarp in a Take.

Parameters:

pTake The Take queried.

Returns:: the TimeWarp count.

FBAnimationNode GetTimeWarpAtIndex	(	HFBTake	pTake,
		long	pIndex
	)

Search for all occurrences

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.

int GetTimeWarpNickNumber	(	HFBTake	pTake,
		FBAnimationNode	pTimeWarp
	)

Search for all occurrences

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.

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

Search for all occurrences

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.

int GetTimeWarpNickNumberAtIndex	(	HFBTake	pTake,
		long	pIndex
	)

Search for all occurrences

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.

FBAnimationNode GetTimeWarpFromNickNumber	(	HFBTake	pTake,
		int	pNumber
	)

Search for all occurrences

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.

int FindTimeWarpNickNumberGlobal ( FBAnimationNode pTimeWarp )

Search for all occurrences

Find the Nick Number of one timewarp globally.

Parameters:

pTimeWarp The TimeWarp queried.

Returns:: the Nick Number of the timewarp.

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

Search for all occurrences

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.

RemoveTimeWarp	(	HFBTake	pTake,
		FBProperty	pEvalProp
	)

Search for all occurrences

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.

TimeWarpRegisterChangeEvent	(	TimeWarpChangeCallback	pCallback,
		pObject
	)

Search for all occurrences

Register a callback Called when some changes related to TimeWarp happen.

Parameters:

pCallback	The callback to register.
pObject	The Parameter for the callback.

TimeWarpUnregisterChangeEvent	(	TimeWarpChangeCallback	pCallback,
		pObject
	)

Search for all occurrences

Unregister a call registered.

Parameters:

pCallback	The callback to be unregister.
pObject	The Parameter for the callback.

FBAnimationNode TimeWarpCreateNew ( str pName )

Search for all occurrences

Create a TimeWarp with a specific name.

Parameters:

pName The name for the TimeWarp.

Returns:: the TimeWarp created.

TimeWarpRename	(	HFBTake	pTake,
		FBAnimationNode	pTimeWarp,
		str	pNewName
	)

Search for all occurrences

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.

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

Search for all occurrences

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.
pTimepNodeWarp	The function curve to merge on.
pTimeWarp	The TimeWarp to be merged.

FBTimeWarpManager TheOne ( )

Search for all occurrences

Get the global object for this class.

Returns:: the global object.

FBTimeWarpManager Class Reference

Detailed Description

Public Member Functions

Member Function Documentation