Public Types | Public Member Functions | Static Public Member Functions

FBTimeWarpManager Class Reference

Search for all occurrences

Detailed Description

Time Warp Manager Interface to the Time Warp Manager.

Definition at line 1006 of file fbdata.h.

#include <fbdata.h>

Inheritance diagram for FBTimeWarpManager:
Inheritance graph
[legend]

List of all members.

Public Types

typedef void(* TimeWarpChangeCallback )(void *pObject)

Public Member Functions

 FBTimeWarpManager ()
 Constructor.
void TimeWarpTakeChange ()
 Call registered callbacks when changes related to TimeWarp happen.
void TimeWarpClearTake (FBTake *pTake)
 Clear all TimeWarp in a Take, and removed from the DataSet.
void TimeWarpInitTake (FBTake *pTake)
 Allocate container for the TimeWarp in one Take.
void TimeWarpCopyTake (FBTake *pDstTake, FBTake *pSrcTake)
 Copy all the TimeWarp in one Take, add to another Take.
void TimeWarpAddToTake (FBTake *pTake, FBAnimationNode *pTimeWarp, int pNickNumber=0)
 Add one TimeWarp to a Take.
void DestroyTimeWarpFromTake (FBTake *pTake, FBAnimationNode *pTimeWarp)
 Destroy the TimeWarp in a Take, and removed from the DataSet.
void RemoveTimeWarpFromScene (FBAnimationNode *pTimeWarp)
 Remove a TimeWarp from Scene.
kLong GetTimeWarpCount (FBTake *pTake)
 Get the count of TimeWarp in a Take.
FBAnimationNodeGetTimeWarpAtIndex (FBTake *pTake, kLong pIndex)
 Get the TimeWarp in a Take At specific Index.
int GetTimeWarpNickNumber (FBTake *pTake, FBAnimationNode *pTimeWarp)
 Get the Nick Number of one TimeWarp in a Take.
bool SetTimeWarpNickNumber (FBTake *pTake, FBAnimationNode *pTimeWarp, int pNumber)
 Set 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.
FBAnimationNodeGetTimeWarpFromNickNumber (FBTake *pTake, int pNumber)
 Get the timeWarp of specific Nick Number in a Take.
int FindTimeWarpNickNumberGlobal (FBAnimationNode *pTimeWarp)
 
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.
void RemoveTimeWarp (FBTake *pTake, FBProperty *pEvalProp)
 Undo apply a timeWarp in a Take to an evaluation property, just disconnect the evaluation property from storing property.
void TimeWarpRegisterChangeEvent (TimeWarpChangeCallback pCallback, void *pObject)
 Register a callback Called when some changes related to TimeWarp happen.
void TimeWarpUnregisterChangeEvent (TimeWarpChangeCallback pCallback, void *pObject)
 Unregister a call registered.
FBAnimationNodeTimeWarpCreateNew (const char *pName)
 
void TimeWarpRename (FBTake *pTake, FBAnimationNode *pTimeWarp, const char *pNewName)
 
void TimeWarpMergeCurveNode (FBTake *pTake, FBProperty *pEvalProp, FBAnimationNode *pNode, FBAnimationNode *pTimeWarpNode)
 

Static Public Member Functions

static FBTimeWarpManagerTheOne ()
 Get the global object for this class.

Member Typedef Documentation

typedef void(* TimeWarpChangeCallback)(void *pObject)

Definition at line 1011 of file fbdata.h.


Constructor & Destructor Documentation

Constructor.

Note:
protect

Member Function Documentation

void TimeWarpTakeChange ( )

Call registered callbacks when changes related to TimeWarp happen.

void TimeWarpClearTake ( FBTake pTake)

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

Parameters:
pTakeThe Take to be cleared.
void TimeWarpInitTake ( FBTake pTake)

Allocate container for the TimeWarp in one Take.

Parameters:
pTakeThe Take allocated for.
void TimeWarpCopyTake ( FBTake pDstTake,
FBTake pSrcTake 
)

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

Parameters:
pDstTakeCopy all TimeWarp to.
pSrcTakeCopy all TimeWarp from.
void TimeWarpAddToTake ( FBTake pTake,
FBAnimationNode pTimeWarp,
int  pNickNumber = 0 
)

Add one TimeWarp to a Take.

Parameters:
pTakeThe Take one TimeWarp added to.
pTimeWarpThe TimeWarp to be added.
pNickNumberThe Nick Number for the TimeWarp.
void DestroyTimeWarpFromTake ( FBTake pTake,
FBAnimationNode pTimeWarp 
)

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

Parameters:
pTakeThe Take where the TimeWarp in.
pTimeWarpThe TimeWarp to be Destroyed.
void RemoveTimeWarpFromScene ( FBAnimationNode pTimeWarp)

Remove a TimeWarp from Scene.

Parameters:
pTimeWarpThe TimeWarp to be Removed.
kLong GetTimeWarpCount ( FBTake pTake)

Get the count of TimeWarp in a Take.

Parameters:
pTakeThe Take queried.
Returns:
the TimeWarp count.
FBAnimationNode* GetTimeWarpAtIndex ( FBTake pTake,
kLong  pIndex 
)

Get the TimeWarp in a Take At specific Index.

Parameters:
pTakeThe Take queried.
pIndexThe index of the TimeWarp.
Returns:
TimeWarp at specific Index in a Take.
int GetTimeWarpNickNumber ( FBTake pTake,
FBAnimationNode pTimeWarp 
)

Get the Nick Number of one TimeWarp in a Take.

Parameters:
pTakeThe Take queried.
pTimeWarpThe TimeWarp queried.
Returns:
the Nick Number of one TimeWarp.
bool SetTimeWarpNickNumber ( FBTake pTake,
FBAnimationNode pTimeWarp,
int  pNumber 
)

Set the Nick Number of one TimeWarp in a Take.

Parameters:
pTakeThe Take specific.
pTimeWarpThe TimeWarp specific.
pNumberThe Nick Number to set.
Returns:
True if set successfully.
int GetTimeWarpNickNumberAtIndex ( FBTake pTake,
kLong  pIndex 
)

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

Parameters:
pTakeThe Take queried.
pIndexThe index a TimeWarp at.
Returns:
the Nick Number of one TimeWarp At specific index.
FBAnimationNode* GetTimeWarpFromNickNumber ( FBTake pTake,
int  pNumber 
)

Get the timeWarp of specific Nick Number in a Take.

Parameters:
pTakeThe Take queried.
pNumberthe Nick Number of one TimeWarp.
Returns:
the TimeWarp of specific Nick Number.
int FindTimeWarpNickNumberGlobal ( FBAnimationNode pTimeWarp)

Find the Nick Number of one timewarp globally

Parameters:
pTimeWarpThe TimeWarp queried.
Returns:
the Nick Number of the timewarp.
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:
pTakeThe Take where the TimeWarp in.
pEvalPropThe evaluation property to be applied on.
pTimeWarpThe TimeWarp to apply.
Returns:
True if apply successfully.
void 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:
pTakeThe Take where the TimeWarp evaluation property connected is in.
pEvalPropThe evaluation property connected a TimeWarp in the storing property of one take.
void TimeWarpRegisterChangeEvent ( TimeWarpChangeCallback  pCallback,
void *  pObject 
)

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

Parameters:
pCallbackThe callback to register.
pObjectThe Parameter for the callback.
void TimeWarpUnregisterChangeEvent ( TimeWarpChangeCallback  pCallback,
void *  pObject 
)

Unregister a call registered.

Parameters:
pCallbackThe callback to be unregister.
pObjectThe Parameter for the callback.
FBAnimationNode* TimeWarpCreateNew ( const char *  pName)

Create a TimeWarp with a specific name

Parameters:
pNameThe name for the TimeWarp.
Returns:
the TimeWarp created.
void TimeWarpRename ( FBTake pTake,
FBAnimationNode pTimeWarp,
const char *  pNewName 
)

Rename a TimeWarp

Parameters:
pTakeThe Take where the timeWarp is in.
pTimeWarpThe TimeWarp to be renamed.
pNewNameThe new name for the TimeWarp.
void 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:
pTakeThe Take that the TimeWarp is in.
pEvalPropthe evaluation property the TimeWarp connected.
pNodeThe function curve to merge on.
pTimeWarpNodeThe TimeWarp to be merged.
static FBTimeWarpManager& TheOne ( ) [static]

Get the global object for this class.

Returns:
the global object.

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

FBTimeWarpManager FBTimeWarpManager FBTimeWarpManager FBTimeWarpManager FBTimeWarpManager FBTimeWarpManager FBTimeWarpManager FBTimeWarpManager FBTimeWarpManager FBTimeWarpManager
FBTimeWarpManager FBTimeWarpManager FBTimeWarpManager FBTimeWarpManager FBTimeWarpManager FBTimeWarpManager FBTimeWarpManager FBTimeWarpManager FBTimeWarpManager FBTimeWarpManager