FBBox Class Reference


Detailed Description

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

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

Inheritance diagram for FBBox:

List of all members.

Public Member Functions

FBAnimationNode AnimationNodeInCreate (uintptr_t pUserId, str pName, str pDataType, bool pIsPublic=False, float pMin=None, float pMax=None, bool pUserData=False)
 Creation of IN/OUT Animation Nodes.
FBAnimationNode AnimationNodeOutCreate (uintptr_t pUserId, str pName, str pDataType, bool pIsPublic=False, float pMin=None, float pMax=None, bool pUserData=False)
bool FbxStore (FBFbxObject pFbxObject, kFbxObjectStore pStoreWhat)
 Storage/Retrieval of information into the FBX file format.
bool FbxRetrieve (FBFbxObject pFbxObject, kFbxObjectStore pStoreWhat)
FBAnimationNode AnimationNodeInGet ()
 Get the (IN/OUT) animation node for this box.
FBAnimationNode AnimationNodeOutGet ()
 __init__ (str pName, object pObject=None)
 Constructor.
bool EvaluateAnimationNodes (FBEvaluateInfo pEvaluateInfo)
 Evaluation of non TRS nodes that needs to be evaluated.
bool AnimationNodeNotify (FBAnimationNode pAnimationNode, FBEvaluateInfo pEvaluateInfo)
 Notification function for animation thread.
bool AnimationNodeDestroy (FBAnimationNode pAnimationNode)
 Destroy an animation node.
bool AnimationNodeIsUserData (FBAnimationNode pAnimationNode)
 Is the animation node user data?.
 AnimationNodesOutDisableIfNotWritten (FBEvaluateInfo pEvaluateInfo)
 This call will disable all out animation nodes from being pull by system (animation thread) for given pEvaluateInfo.
str FbxGetObjectSubType ()
 returns UniqueName if not overloaded.
str FbxGetObjectType ()
 Object Type "Box".
 IObject_Declare (K_IMPLEMENTATION)

Public Attributes

str UniqueName
 internal Unique name.
FBPropertyBase Animatable
 Read Write Property: Is the box animatable.
FBPropertyBase Live
 Read Write Property: Is live?.
FBPropertyBase RecordMode
 Read Write Property: Is recording?.

Member Function Documentation

FBAnimationNode AnimationNodeInCreate ( uintptr_t  pUserId,
str  pName,
str  pDataType,
bool  pIsPublic = False,
float  pMin = None,
float  pMax = None,
bool  pUserData = False 
)

Creation of IN/OUT Animation Nodes.

Parameters:
pUserIdUser-defined reference number.
pNameName of animation node.
pDataTypeType of data being animated.
pIsPublicDetermine if the animation node is published, that means whether to show it in property editor and have input / output in relation constraints editor (default is false).
pMinMinimum values for data (default is NULL).
pMaxMaximum values for data (default is NULL).
pUserDataIs this user data? False means the property is NOT animated, user cannot change the data. Especially for device, it doesn't make sense to make it animated, unless you want to record the device data. (default is false).
Returns:
A handle to the newly created animation node.

Reimplemented in FBDevice.

FBAnimationNode AnimationNodeOutCreate ( uintptr_t  pUserId,
str  pName,
str  pDataType,
bool  pIsPublic = False,
float  pMin = None,
float  pMax = None,
bool  pUserData = False 
)
bool FbxStore ( FBFbxObject  pFbxObject,
kFbxObjectStore  pStoreWhat 
)

Storage/Retrieval of information into the FBX file format.

Parameters:
pFbxObjectObject to interface with FBX file format.
pStoreWhatAttributes to store in FBX file.
Returns:
true if successful.

Reimplemented in FBConstraint, FBDevice, FBDeviceOptical, FBHUDElement, FBMaterial, FBModel, FBModelMarker, FBModelNull, and FBUserObject.

bool FbxRetrieve ( FBFbxObject  pFbxObject,
kFbxObjectStore  pStoreWhat 
)
FBAnimationNode AnimationNodeInGet ( )

Get the (IN/OUT) animation node for this box.

Returns:
A handle to the animation node for this box.
bool EvaluateAnimationNodes ( FBEvaluateInfo  pEvaluateInfo)

Evaluation of non TRS nodes that needs to be evaluated.

This function is called by the real-time engine in order to process animation information.

Parameters:
pEvaluateInfoInformation concerning the evaluation of the animation (time, etc.)
Returns:
true if animation node notification is successful.
bool AnimationNodeNotify ( FBAnimationNode  pAnimationNode,
FBEvaluateInfo  pEvaluateInfo 
)

Notification function for animation thread.

This function is called by the real-time engine in order to process animation information.

Parameters:
pAnimationNodeNode containing the modified information.
pEvaluateInfoInformation concerning the evaluation of the animation (time, etc.)
Returns:
true if animation node notification is successful.

Reimplemented in FBDevice, and FBDeviceOptical.

bool AnimationNodeDestroy ( FBAnimationNode  pAnimationNode)

Destroy an animation node.

Parameters:
pAnimationNodeHandle to the animation node to be destroyed.
Returns:
true if destruction was successful.
bool AnimationNodeIsUserData ( FBAnimationNode  pAnimationNode)

Is the animation node user data?.

Parameters:
pAnimationNodeHandle to the animation to be queried.
Returns:
true if node is user data.
AnimationNodesOutDisableIfNotWritten ( FBEvaluateInfo  pEvaluateInfo)

This call will disable all out animation nodes from being pull by system (animation thread) for given pEvaluateInfo.

Parameters:
pEvaluateInfoEvaluation synchronization object (contains evaluation id).
Note:
This can be also done per individual AnimationNode -> FBAnimationNode.DisableIfNotWritten
str FbxGetObjectSubType ( )

returns UniqueName if not overloaded.

Reimplemented in FBMaterial, FBModel, FBModelMarker, and FBModelNull.

str FbxGetObjectType ( )

Object Type "Box".

Reimplemented in FBDevice, FBMaterial, FBModel, FBModelMarker, and FBModelNull.

IObject_Declare ( K_IMPLEMENTATION  )

Member Data Documentation

internal Unique name.

FBPropertyBase Animatable

Read Write Property: Is the box animatable.

FBPropertyBase Live

Read Write Property: Is live?.

FBPropertyBase RecordMode

Read Write Property: Is recording?.


FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox
FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox