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 929 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 (HFBTake pTake)
  Clear all TimeWarp in a Take, and removed from the DataSet.
void  TimeWarpInitTake (HFBTake pTake)
  Allocate container for the TimeWarp in one Take.
void  TimeWarpCopyTake (HFBTake pDstTake, HFBTake pSrcTake)
  Copy all the TimeWarp in one Take, add to another Take.
void  TimeWarpAddToTake (HFBTake pTake, HFBAnimationNode pTimeWarp, int pNickNumber=0)
  Add one TimeWarp to a Take.
void  DestroyTimeWarpFromTake (HFBTake pTake, HFBAnimationNode pTimeWarp)
  Destroy the TimeWarp in a Take, and removed from the DataSet.
void  RemoveTimeWarpFromScene (HFBAnimationNode pTimeWarp)
  Remove a TimeWarp from Scene.
kLong  GetTimeWarpCount (HFBTake pTake)
  Get the count of TimeWarp in a Take.
HFBAnimationNode  GetTimeWarpAtIndex (HFBTake pTake, kLong pIndex)
  Get the TimeWarp in a Take At specific Index.
int  GetTimeWarpNickNumber (HFBTake pTake, HFBAnimationNode pTimeWarp)
  Get the Nick Number of one TimeWarp in a Take.
bool  SetTimeWarpNickNumber (HFBTake pTake, HFBAnimationNode pTimeWarp, int pNumber)
  Set the Nick Number of one TimeWarp in a Take.
int  GetTimeWarpNickNumberAtIndex (HFBTake pTake, kLong pIndex)
  Get the Nick Number of one TimeWarp At specific index in a Take.
HFBAnimationNode  GetTimeWarpFromNickNumber (HFBTake pTake, int pNumber)
  Get the timeWarp of specific Nick Number in a Take.
int  FindTimeWarpNickNumberGlobal (HFBAnimationNode pTimeWarp)
 
bool  ApplyTimeWarp (HFBTake pTake, FBProperty *pEvalProp, HFBAnimationNode 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 (HFBTake 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.
HFBAnimationNode  TimeWarpCreateNew (char *pName)
 
void  TimeWarpRename (HFBTake pTake, HFBAnimationNode pTimeWarp, char *pNewName)
 
void  TimeWarpMergeCurveNode (HFBTake pTake, FBProperty *pEvalProp, HFBAnimationNode pNode, HFBAnimationNode pTimeWarpNode)
 

Static Public Member Functions

static FBTimeWarpManager TheOne ()
  Get the global object for this class.

Member Typedef Documentation

typedef void(* TimeWarpChangeCallback)(void *pObject)

Definition at line 934 of file fbdata.h.


Constructor & Destructor Documentation

Constructor.

protect


Member Function Documentation

void TimeWarpTakeChange ( )

Call registered callbacks when changes related to TimeWarp happen.

void TimeWarpClearTake ( HFBTake  pTake )

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

Parameters:
pTake The Take to be cleared.
void TimeWarpInitTake ( HFBTake  pTake )

Allocate container for the TimeWarp in one Take.

Parameters:
pTake The Take allocated for.
void TimeWarpCopyTake ( HFBTake  pDstTake,
HFBTake  pSrcTake 
)

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

Parameters:
pDstTake Copy all TimeWarp to.
pSrcTake Copy all TimeWarp from.
void TimeWarpAddToTake ( HFBTake  pTake,
HFBAnimationNode  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.
void DestroyTimeWarpFromTake ( HFBTake  pTake,
HFBAnimationNode  pTimeWarp 
)

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.
void RemoveTimeWarpFromScene ( HFBAnimationNode  pTimeWarp )

Remove a TimeWarp from Scene.

Parameters:
pTimeWarp The TimeWarp to be Removed.
kLong GetTimeWarpCount ( HFBTake  pTake )

Get the count of TimeWarp in a Take.

Parameters:
pTake The Take queried.
Returns:
the TimeWarp count.
HFBAnimationNode GetTimeWarpAtIndex ( HFBTake  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.
int GetTimeWarpNickNumber ( HFBTake  pTake,
HFBAnimationNode  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.
bool SetTimeWarpNickNumber ( HFBTake  pTake,
HFBAnimationNode  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.
int GetTimeWarpNickNumberAtIndex ( HFBTake  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.
HFBAnimationNode GetTimeWarpFromNickNumber ( HFBTake  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.
int FindTimeWarpNickNumberGlobal ( HFBAnimationNode  pTimeWarp )

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,
HFBAnimationNode  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.
void RemoveTimeWarp ( HFBTake  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.
void TimeWarpRegisterChangeEvent ( TimeWarpChangeCallback  pCallback,
void *  pObject 
)

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

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

Unregister a call registered.

Parameters:
pCallback The callback to be unregister.
pObject The Parameter for the callback.
HFBAnimationNode TimeWarpCreateNew ( char *  pName )

Create a TimeWarp with a specific name

Parameters:
pName The name for the TimeWarp.
Returns:
the TimeWarp created.
void TimeWarpRename ( HFBTake  pTake,
HFBAnimationNode  pTimeWarp,
char *  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.
void TimeWarpMergeCurveNode ( HFBTake  pTake,
FBProperty pEvalProp,
HFBAnimationNode  pNode,
HFBAnimationNode  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.
pTimepNodeWarp The function curve to merge on.
pTimeWarp The 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