FBAnimationNode Class Reference

FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode FBAnimationNode

Inheritance diagram for FBAnimationNode:

[legend]

List of all members.

---

Detailed Description

See samples: CopyAnimation.py, ClearKeysOnSelectedModels.py, FCurveEditor.py.

Public Member Functions
	FBAnimationNode (str pName=None)
	Constructor.
FBTime	ConvertGlobalToNodeTime (FBTime pKeyTime)
	Convert global time to node time.
FBTime	ConvertNodeToGlobalTime (FBTime pKeyTime)
	Convert node time to global time.
FBAnimationNode	GetAnimationToPlay ()
	Get animation node to play from.
FBAnimationNode	GetAnimationToRecord ()
	Get animation node to record to.
int	GetDataDoubleArrayCount ()
	If the DataPtr is of numeric value type .
int	GetSizeOfData ()
	Get sizeof void Data Ptr.
bool	IsKey ()
	Verifies if there is a key at the current.
	KeyAdd (FBTime pTime, float pData)
	Add a key to the animation node.
	KeyAdd (float pData)
	Add a key to the animation node at current time.
	KeyCandidate ()
	Keys the current candidate values for current time.
	KeyRemove ()
	Remove key at current time.
	SetBufferType (bool pGlobal)
	Set buffer type for ANIMATIONNODE_TYPE_LOCAL_TRANSLATION, ANIMATIONNODE_TYPE_LOCAL_ROTATION and ANIMATIONNODE_TYPE_LOCAL_SCALE.
bool	SetCandidate (float Data)
	Set the current candidate values for current time.
bool	WriteData (float Data, FBEvaluateInfo pEvaluateInfo)
	Write data to animation node.
Public Attributes
FBInterpolation	DefaultInterpolation
	Read Write Property: Default type of interpolation.
FBFCurve	FCurve
	Read Write Property: FCurve for animation. See sample: StartKeysAtCurrentTime.py.
int	KeyCount
	Read Only Property: Number of keys.
str	Label
	Read Write Property: Label (UI Name).
bool	Live
	Read Write Property: Is animation live?
FBListAnimationNode	Nodes
	List: List of animation nodes.
bool	RecordMode
	Read Write Property: Is the node in recording mode (device connectors)?
str	UserName
	Read Only Property: Name of animation node.

---

Constructor & Destructor Documentation

FBAnimationNode

(

str

pName = None

)

Constructor.

Parameters:

pName

Name of animation node (default is NULL).

---

Member Function Documentation

FBTime ConvertGlobalToNodeTime

(

FBTime

pKeyTime

)

Convert global time to node time.

(NOTE: Only used in the context of a story clip)

Parameters:

pKeyTime

Time of the key to convert.

FBTime ConvertNodeToGlobalTime

(

FBTime

pKeyTime

)

Convert node time to global time.

(NOTE: Only used in the context of a story clip)

Parameters:

pKeyTime

Time of the key to convert.

FBAnimationNode GetAnimationToPlay

(

)

Get animation node to play from.

Returns:

Animation node to be played.

FBAnimationNode GetAnimationToRecord

(

)

Get animation node to record to.

Returns:

Animation node to record to.

int GetDataDoubleArrayCount

(

)

If the DataPtr is of numeric value type .

.. get the size of the array ex: Light Intensity:1, Translation 3

Returns:

Size of DataPtr array.

int GetSizeOfData

(

)

Get sizeof void Data Ptr.

bool IsKey

(

)

Verifies if there is a key at the current.

Returns:

true if there is a key at the current time.

KeyAdd	(	FBTime	pTime,
		float	pData
	)

Add a key to the animation node.

Parameters:

	pTime	Time to add key at.
	pData	Value of data to add at pTime.

KeyAdd

(

float

pData

)

Add a key to the animation node at current time.

Parameters:

pData

Value of data to add.

KeyCandidate

(

)

Keys the current candidate values for current time.

KeyRemove

(

)

Remove key at current time.

SetBufferType

(

bool

pGlobal

)

Set buffer type for ANIMATIONNODE_TYPE_LOCAL_TRANSLATION, ANIMATIONNODE_TYPE_LOCAL_ROTATION and ANIMATIONNODE_TYPE_LOCAL_SCALE.

Parameters:

pGlobal

Is buffer local or global.

bool SetCandidate

(

float

Data

)

Set the current candidate values for current time.

Returns:

true if successful.

bool WriteData	(	float	Data,
		FBEvaluateInfo	pEvaluateInfo
	)

Write data to animation node.

Parameters:

	Data	Data to write to animation node.
	pEvaluateInfo	Node evaluation information (access to system and local time).

Returns:

true if successful.

---

Member Data Documentation

FBInterpolation DefaultInterpolation

Read Write Property: Default type of interpolation.

FBFCurve FCurve

Read Write Property: FCurve for animation. See sample: StartKeysAtCurrentTime.py.

int KeyCount

Read Only Property: Number of keys.

str Label

Read Write Property: Label (UI Name).

bool Live

Read Write Property: Is animation live?

FBListAnimationNode Nodes

List: List of animation nodes.

bool RecordMode

Read Write Property: Is the node in recording mode (device connectors)?

str UserName

Read Only Property: Name of animation node.

---