KFbxAnimEvalState Class Reference

This reference page is linked to from the following overview topics: FBX SDK 2011.

---

Search for all occurrences

---

Detailed Description

This class hold results from animation evaluations.

To re-use an evaluation state, it is possible to invalidate or to reset it. Invalidating an evaluation state is the quickest way to re-use an evaluation state object for the same scene with the same objects, because it only zeros all the entries, while a reset will delete all entries. Unless the scene change, it is recommended to invalidate evaluation states instead of resetting them, for performance purposes.

See also:

KFbxAnimEvaluator

Definition at line 57 of file kfbxanimevalstate.h.

#include <kfbxanimevalstate.h>

List of all members.

Public Member Functions
	KFbxAnimEvalState ()
	Constructor.
KTime	GetTime () const
	Get the time of this evaluation state.
void	Reset ()
	Reset an evaluation state by deleting the cache it contains.
void	Invalidate (KTime pTime)
	Invalidate an evaluation state by zeroing the cache it contains, and changing its associated time.
void	InvalidateNode (KFbxNode *pNode)
	Invalidate a node evaluation state.
void	InvalidateProperty (KFbxProperty &pProperty)
	Invalidate a property evaluation state.
KFbxNodeEvalState *	GetNodeTransform (KFbxNode *pNode, int &pDirectIndex, bool &pNeedEval)
	Get node transform evaluation result from the evaluation state.
void	SetNodeEvaluated (int pDirectIndex)
	Set a node evaluate state to evaluated.
KFbxAnimCurveNode *	GetPropertyValue (KFbxProperty &pProperty, int &pDirectIndex, bool &pNeedEval, KFbxScene *pScene)
	Get a property evaluation result from the evaluation state.
void	SetPropertyEvaluated (int pDirectIndex)
	Set a property evaluate state to evaluated.
virtual	~KFbxAnimEvalState ()

---

Constructor & Destructor Documentation

KFbxAnimEvalState

(

)

Constructor.

virtual ~KFbxAnimEvalState

(

)

[virtual]

---

Member Function Documentation

KTime GetTime

(

)

const

Search for all occurrences

Get the time of this evaluation state.

Returns:

The time associated with this evaluation state.

void Reset

(

)

Search for all occurrences

Reset an evaluation state by deleting the cache it contains.

This will remove all entries in the cache.

void Invalidate

(

KTime

pTime

)

Search for all occurrences

Invalidate an evaluation state by zeroing the cache it contains, and changing its associated time.

All node and property entries will remain in the list, but will become in an not-evaluated state.

Parameters:

pTime

The time at which the evaluation state should be set after the invalidation.

void InvalidateNode

(

KFbxNode *

pNode

)

Search for all occurrences

Invalidate a node evaluation state.

Parameters:

pNode

The node that needs to be re-evaluated in next evaluation.

void InvalidateProperty

(

KFbxProperty &

pProperty

)

Search for all occurrences

Invalidate a property evaluation state.

Parameters:

pProperty

The property that needs to be re-evaluated in next evaluation.

KFbxNodeEvalState* GetNodeTransform	(	KFbxNode *	pNode,
		int &	pDirectIndex,
		bool &	pNeedEval
	)

Search for all occurrences

Get node transform evaluation result from the evaluation state.

Parameters:

pNode	The node for which the value was stored.
pDirectIndex	Index to retrieve the information in the evaluation state array, to speed up performance. (Use -1 if index is unknown).
pNeedEval	The function will set this parameter to true if the value in the state needs a re-evaluation.

Returns:

The global or local matrix transform for the specified node.

void SetNodeEvaluated

(

int

pDirectIndex

)

Search for all occurrences

Set a node evaluate state to evaluated.

Parameters:

pDirectIndex

The index of the node in the evaluation state.

KFbxAnimCurveNode* GetPropertyValue	(	KFbxProperty &	pProperty,
		int &	pDirectIndex,
		bool &	pNeedEval,
		KFbxScene *	pScene
	)

Search for all occurrences

Get a property evaluation result from the evaluation state.

Parameters:

pProperty	The property for which the value was stored.
pDirectIndex	Index to retrieve the information in the evaluation state array, to speed up performance. (Use -1 if index is unknown).
pNeedEval	The function will set this parameter to true if the value in the state needs a re-evaluation.
pScene	The FBX scene used for evaluation

Returns:

The result value that was stored.

Remarks:

This function is not well suited for real-time applications, since it performs a find in the array. But its reliable and simple to use.

void SetPropertyEvaluated

(

int

pDirectIndex

)

Search for all occurrences

Set a property evaluate state to evaluated.

Parameters:

pDirectIndex

The index of the property in the evaluation state.

---

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

• fbxfilesdk/kfbxplugins/kfbxanimevalstate.h