This reference page is linked to from the following overview topics: Your First Python Program, Threading, FBBox, Motion Capture Devices.

Detailed Description

A box is a fundamental building block in the application architecture.

All animatable elements derive in some way from the main box class, either by deriving directly or owning a box.

Definition at line 219 of file fbcore.h.

#include <fbcore.h>

Inheritance diagram for FBBox:

[legend]

List of all members.

Public Member Functions
	FBBox (char *pName, HIObject pObject=NULL)
	Constructor.
virtual bool	EvaluateAnimationNodes (HFBEvaluateInfo pEvaluateInfo)
	Evaluation of non TRS nodes that needs to be evaluated.
virtual bool	AnimationNodeNotify (HFBAnimationNode pAnimationNode, HFBEvaluateInfo pEvaluateInfo)
	Notification function for animation thread.
virtual bool	AnimationNodeDestroy (HFBAnimationNode pAnimationNode)
	Destroy an animation node.
virtual bool	AnimationNodeIsUserData (HFBAnimationNode pAnimationNode)
	Is the animation node user data?
virtual char *	FbxGetObjectSubType ()
	returns UniqueName if not overloaded.
virtual char *	FbxGetObjectType ()
	Object Type "Box".
	IObject_Declare (Implementation)

virtual HFBAnimationNode	AnimationNodeInCreate (kReference pUserId, char pName, char pDataType, bool pIsPublic=false, double pMin=NULL, double pMax=NULL, bool pUserData=false)
	Creation of IN/OUT Animation Nodes.
virtual HFBAnimationNode	AnimationNodeOutCreate (kReference pUserId, char pName, char pDataType, bool pIsPublic=false, double pMin=NULL, double pMax=NULL, bool pUserData=false)

virtual bool	FbxStore (HFBFbxObject pFbxObject, kFbxObjectStore pStoreWhat)
	Storage/Retrieval of information into the FBX file format.
virtual bool	FbxRetrieve (HFBFbxObject pFbxObject, kFbxObjectStore pStoreWhat)

virtual HFBAnimationNode	AnimationNodeInGet ()
	Get the (IN/OUT) animation node for this box.
virtual HFBAnimationNode	AnimationNodeOutGet ()
Public Attributes
char *	UniqueName
	internal Unique name.
FBPropertyBool	Animatable
	Read Write Property: Is the box animatable.
FBPropertyBool	Live
	Read Write Property: Is live?
FBPropertyBool	RecordMode
	Read Write Property: Is recording?

Constructor & Destructor Documentation

FBBox	(	char *	pName,
		HIObject	pObject = `NULL`
	)

Constructor.

Parameters:

pName	Box name.
pObject	For internal use only (default is NULL).

Member Function Documentation

virtual HFBAnimationNode AnimationNodeInCreate	(	kReference	pUserId,
		char *	pName,
		char *	pDataType,
		bool	pIsPublic = `false`,
		double *	pMin = `NULL`,
		double *	pMax = `NULL`,
		bool	pUserData = `false`
	)		`[virtual]`

Search for all occurrences

Creation of IN/OUT Animation Nodes.

Parameters:

pUserId	User-defined reference number.
pName	Name of animation node.
pDataType	Type of data being animated.
pIsPublic	Determine if the animation node is published (default is false).
pMin	Minimum values for data (default is NULL).
pMax	Maximum values for data (default is NULL).
pUserData	Is this user data? (default is false)

Returns:: A handle to the newly created animation node.

Reimplemented in FBDevice.

virtual HFBAnimationNode AnimationNodeOutCreate	(	kReference	pUserId,
		char *	pName,
		char *	pDataType,
		bool	pIsPublic = `false`,
		double *	pMin = `NULL`,
		double *	pMax = `NULL`,
		bool	pUserData = `false`
	)		`[virtual]`