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

#include <fbdata.h>

Inheritance diagram for FBTimeWarpManager:

[legend]

Public Types
typedef void(*	TimeWarpChangeCallback) (void *pObject)

Public Member Functions
	FBTimeWarpManager ()
	Constructor. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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. More...

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. More...

void	TimeWarpRegisterChangeEvent (TimeWarpChangeCallback pCallback, void *pObject)
	Register a callback Called when some changes related to TimeWarp happen. More...

void	TimeWarpUnregisterChangeEvent (TimeWarpChangeCallback pCallback, void *pObject)
	Unregister a call registered. More...

FBAnimationNode *	TimeWarpCreateNew (const char *pName)

void	TimeWarpRename (FBTake pTake, FBAnimationNode pTimeWarp, const char *pNewName)

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

Public Member Functions inherited from FBComponent
	FBComponent (HIObject pObject)
	Constructor. More...

virtual	~FBComponent ()
	Destructor. More...

virtual bool	FBCreate ()
	Open Reality Creation function. More...

virtual void	FBDestroy ()
	Open Reality destruction function. More...

virtual void	FBDelete () override
	Open Reality deletion function. More...

virtual bool	SetHIObject (HIObject pObject, bool pSDKComponent) override
	Assign component to an internal pointer. More...

virtual int	PropertyAdd (FBProperty *pProperty)
	Add a property to the component's property manager. More...

bool	PropertyAddReferenceProperty (FBProperty *pReferenceProperty)
	Add a reference property to the component's property manager. More...

void	PropertyRemove (FBProperty *pProperty)
	Remove a Property from the component's Property manager. More...

void	PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading. More...

FBProperty *	PropertyCreate (const char pName, FBPropertyType pType, const char pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
	Create user or dynamic property. More...

FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated). More...

void	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags. More...

bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled. More...

void	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags. More...

void	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags. More...

void	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status. More...

bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled. More...

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessNamespaceHierarchy. More...

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessObjectNamespace. More...

virtual const char *	ClassName () override
	Get the class name. More...

virtual bool	UseCustomPropertyViewSet () const
	Use the custom property viewSet or not. More...

const char *	GetFullName (void)
	Get the full name. More...

void	SetOwnerNamespace (FBNamespace *pOwnerNSObj)
	Set the owner Namespace object. More...

FBNamespace *	GetOwnerNamespace (void)
	Get the owner Namespace object. More...

FBFileReference *	GetOwnerFileReference (void)
	Get the owner FileReference object. More...

void	HardSelect ()
	HardSelect. More...

virtual bool	Is (int pTypeId) override
	Returns true if object is of type TypeId. More...

virtual int	GetTypeId () override
	GetTypeId( int pTypeId ) More...

Public Member Functions inherited from FBWrapperHolder
FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject. More...

void	AddWrapper (FBScriptWrapper *)

void	RemoveWrapper (FBScriptWrapper *)

Static Public Member Functions
static FBTimeWarpManager &	TheOne ()
	Get the global object for this class. More...

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)

Additional Inherited Members
Public Attributes inherited from FBComponent
FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component. More...

FBPropertyListComponent	Components
	List: List of components. More...

FBPropertyListComponent	Parents
	List: Parents. More...

FBPropertyBool	Selected
	Read Write Property: Selected property. More...

FBPropertyString	Name
	Read Write Property: Unique name of object. More...

FBPropertyString	LongName
	Read Write Property: Name and namespace for object. More...

FBPropertyFolder	Folder
	Read Write Property: The folder that contain this component. More...

Static Public Attributes inherited from FBComponent
static int	TypeInfo
	Contains the Type information of the object. More...

Protected Member Functions inherited from FBPlug
bool	IsSDKComponent ()
	Return whether or not item is an SDK component. More...

bool	ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection. More...

bool	ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection. More...

bool	ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection. More...

bool	ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection. More...

bool	DisconnectDst (FBPlug *pDst)
	Remove a destination connection. More...

bool	DisconnectSrc (FBPlug *pSrc)
	Remove a source connection. More...

void	DisconnectAllSrc ()
	Remove all source connections. More...

void	DisconnectAllDst ()
	Remove all destination connections. More...

bool	DisconnectDstAt (int pIndex)
	Remove a destination connection at a specified index. More...

bool	DisconnectSrcAt (int pIndex)
	Remove a source connection at a specified index. More...

bool	ReplaceDstAt (int pIndex, FBPlug *pDst)
	Replace a destination connection at a specified index. More...

bool	ReplaceSrcAt (int pIndex, FBPlug *pSrc)
	Replace a source connection at a specified index. More...

bool	SwapSrc (int pIndexA, int pIndexB)
	Swap source connection at index A with source connection at index B. More...

bool	MoveSrcAt (int pIndex, int pAtIndex)
	Move source connection at pIndex to pAtIndex. More...

bool	MoveSrcAt (FBPlug pSrc, FBPlug pAtSrc)
	Move source connection pSrc to the position of pAtSrc. More...

int	GetSrcCount ()
	Get source connection count. More...

FBPlug *	GetSrc (int pIndex)
	Get a source connection's plug at specified index. More...

FBConnectionType	GetSrcType (int pIndex)
	Get a source connection's type at specified index. More...

int	GetDstCount ()
	Get destination connection count. More...

FBPlug *	GetDst (int pIndex)
	Get a destination connection's plug at specified index. More...

FBConnectionType	GetDstType (int pIndex)
	Get a destination connection's type at specified index. More...

bool	BeginChange ()
	Begins a change on multiple plugs. More...

void	EndChange ()
	Ends a change on multiple plugs. More...

void	SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's self modification flag. More...

bool	GetSelfModified (FBPlugModificationFlag pFlag)
	Tell if the plug's self has changed. More...

void	SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's owned property/object's modification flag. More...

bool	GetContentModified (FBPlugModificationFlag pFlag)
	Tell if the plug's content has changed. More...

int	GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
	Get plug's modified src/dst property/object connection added/removed List. More...

bool	RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
	Revert the plug's modification to original status. More...

void	SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
	Set the plug's status flag. More...

bool	GetStatusFlag (FBPlugStatusFlag pStatus) const
	Tell if the plug's status has changed. More...

FBPlug *	GetOwner ()
	Get the owner of this plug. More...

FBPlug *	GetOwned (int pIndex)
	Get the owned plug at specified index. More...

int	GetOwnedCount ()
	Get the owned plug count. More...

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. More...

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. More...

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. More...

Static Protected Member Functions inherited from FBPlug
static int	GetInternalClassId ()
	Internal class Id. More...

Protected Attributes inherited from FBPlug
bool	mAllocated
	Contain the Allocation State of the Component. More...

HIObject	mObject
	Handle on the Plug. More...

bool	mSDKComponent
	bool Plug is an SDK component. More...

Static Protected Attributes inherited from FBPlug
static const char *	ClassGroupName
	ClassGroupName of the object. More...

static int	TypeInfo
	TypeInfo. More...

static int	mGlobalTypeInfo
	Represente the Type Index. More...

Detailed Description

Time Warp Manager Interface to the Time Warp Manager.

Definition at line 2152 of file fbdata.h.

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).

Deprecated:: Use the RemoveTimeWarpFromScene method (the one with two parameters) instead.

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()

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

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.

Deprecated:: Use the RemoveTimeWarpFromScene method (the one with two parameters) instead.

Parameters

pTimeWarp The TimeWarp to be Removed.

◆ RemoveTimeWarpFromScene() [2/2]

void 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.

◆ TheOne()

static FBTimeWarpManager& TheOne ( )

static

Get the global object for this class.

Returns: the global object.

◆ TimeWarpAddToTake()

void 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()

void TimeWarpClearTake ( FBTake * pTake )

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

Parameters

pTake The Take to be cleared.

◆ TimeWarpCopyTake()

void 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 ( const char * pName )

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

Parameters

pName The name for the TimeWarp.

Returns: the TimeWarp created.

◆ TimeWarpInitTake()

void TimeWarpInitTake ( FBTake * pTake )

Allocate container for the TimeWarp in one Take.

Parameters

pTake The Take allocated for.

◆ TimeWarpMergeCurveNode()

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

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.

◆ TimeWarpRegisterChangeEvent()

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.

◆ TimeWarpRename()

void TimeWarpRename	(	FBTake *	pTake,
		FBAnimationNode *	pTimeWarp,
		const 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.

◆ TimeWarpTakeChange()

void TimeWarpTakeChange ( )

Call registered callbacks when changes related to TimeWarp happen.

◆ TimeWarpUnregisterChangeEvent()

void TimeWarpUnregisterChangeEvent	(	TimeWarpChangeCallback	pCallback,
		void *	pObject
	)

Unregister a call registered.

Parameters

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

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

fbdata.h

Public Types

Public Member Functions

Static 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()

◆ TheOne()

◆ TimeWarpAddToTake()

◆ TimeWarpClearTake()

◆ TimeWarpCopyTake()

◆ TimeWarpCreateNew()

◆ TimeWarpInitTake()

◆ TimeWarpMergeCurveNode()

◆ TimeWarpRegisterChangeEvent()

◆ TimeWarpRename()

◆ TimeWarpTakeChange()

◆ TimeWarpUnregisterChangeEvent()