KFbxTakeNode Class Reference

#include <kfbxtakenode.h>

List of all members.

---

Detailed Description

A take node contains channels of animation.

An object derived from class KFbxTakeNodeContainer contains multiple take nodes to hold animation data.

In the case of class KFbxNode, a take node contains all animation curves necessary to define the animation for a node and its attribute. By having multiple take nodes, a node might be animated differently. A scene description held in a node hierarchy can be animated differently using different animation take nodes.

This object can be used to access the different animation curves that define a take node. Some channels are only accessible once the proper node attribute has been associated with an object of type KFbxNode.

Definition at line 77 of file kfbxtakenode.h.

Error Management
enum	EError {    eNO_CURVE_FOUND,    eERROR_COUNT }
	Error identifiers. More...
KError &	GetError ()
	Retrieve error object.
EError	GetLastErrorID () const
	Get last error code.
const char *	GetLastErrorString () const
	Get last error string.
Take Node creation/destruction.
	KFbxTakeNode (char *pName=KFBXTAKENODE_DEFAULT_NAME)
	Constructor.
	KFbxTakeNode (KFbxTakeNode &pTakeNode)
	Copy constructor.
	~KFbxTakeNode ()
	Destructor.
Take Node name management.
void	SetName (char *pName)
	Set take node name.
char *	GetName ()
	Get take node name.
Utility functions used by some plugins etc.
bool	GetAnimationInterval (KTime &pStart, KTime &pStop)
	Find out start and end time of the animation.
bool	AddRotationToTranslation (KFbxVector4 pRotation)
	Rotates the translation animation at a given angle.
Public Member Functions
KFCurveNode *	GetKFCurveNode ()
	Get pointer to root KFCurveNode object.

---

Member Enumeration Documentation

enum EError

Error identifiers.

Enumerator:

eNO_CURVE_FOUND	The requested FCurve was not found.
eERROR_COUNT	Mark the end of the EError enum.

Definition at line 135 of file kfbxtakenode.h.

---

Constructor & Destructor Documentation

KFbxTakeNode

(

char *

pName = KFBXTAKENODE_DEFAULT_NAME

)

Constructor.

Parameters:

pName

The name of the take this node is part of.

KFbxTakeNode

(

KFbxTakeNode &

pTakeNode

)

Copy constructor.

Parameters:

pTakeNode

A node from which data is cloned.

~KFbxTakeNode

(

)

Destructor.

---

Member Function Documentation

void SetName

(

char *

pName

)

Set take node name.

Parameters:

pName

The name of the take this node is part of.

char* GetName

(

)

Get take node name.

Returns:

Return the name of the take this node is part of.

KFCurveNode* GetKFCurveNode

(

)

Get pointer to root KFCurveNode object.

Remarks:

All the channels of a take node are accessible by browsing the KFCurveNode tree under this object.

KError& GetError

(

)

Retrieve error object.

Returns:

Reference to the take node's error object.

EError GetLastErrorID

(

)

const

Get last error code.

Returns:

Last error code.

const char* GetLastErrorString

(

)

const

Get last error string.

Returns:

Textual description of the last error.

bool GetAnimationInterval	(	KTime &	pStart,
		KTime &	pStop
	)

Find out start and end time of the animation.

This function retrieves the including time span for all the FCurve's time span of this take node.

Parameters:

	pStart	Reference to receive start time.
	pStop	Reference to receive end time.

Returns:

true on success, false otherwise.

bool AddRotationToTranslation

(

KFbxVector4

pRotation

)

Rotates the translation animation at a given angle.

Parameters:

pRotation

vector containing the rotation.

Returns:

True if everything went ok.