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.
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?. |
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.
pUserId | User-defined reference number. |
pName | Name of animation node. |
pDataType | Type of data being animated. |
pIsPublic | Determine 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). |
pMin | Minimum values for data (default is NULL). |
pMax | Maximum values for data (default is NULL). |
pUserData | Is 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). |
Reimplemented in FBDevice.
FBAnimationNode AnimationNodeOutCreate | ( | uintptr_t | pUserId, |
str | pName, | ||
str | pDataType, | ||
bool | pIsPublic = False , |
||
float | pMin = None , |
||
float | pMax = None , |
||
bool | pUserData = False |
||
) |
Reimplemented in FBDevice.
bool FbxStore | ( | FBFbxObject | pFbxObject, |
kFbxObjectStore | pStoreWhat | ||
) |
Storage/Retrieval of information into the FBX file format.
pFbxObject | Object to interface with FBX file format. |
pStoreWhat | Attributes to store in FBX file. |
Reimplemented in FBConstraint, FBDevice, FBDeviceOptical, FBHUDElement, FBMaterial, FBModel, FBModelMarker, FBModelNull, and FBUserObject.
bool FbxRetrieve | ( | FBFbxObject | pFbxObject, |
kFbxObjectStore | pStoreWhat | ||
) |
Reimplemented in FBConstraint, FBDevice, FBDeviceOptical, FBHUDElement, FBMaterial, FBModel, FBModelMarker, FBModelNull, and FBUserObject.
FBAnimationNode AnimationNodeInGet | ( | ) |
Get the (IN/OUT) animation node for this box.
FBAnimationNode AnimationNodeOutGet | ( | ) |
Constructor.
pName | Box name. |
pObject | For internal use only (default is NULL). |
Reimplemented in FBActor, FBCamera, FBCameraStereo, FBCharacter, FBCharacterFace, FBConstraint, FBConstraintSolver, FBDevice, FBDeviceOptical, FBGroup, FBHUD, FBHUDElement, FBHUDFlashElement, FBHUDRectElement, FBHUDTextElement, FBHUDTextureElement, FBHandle, FBLayeredTexture, FBLight, FBMaterial, FBModel, FBModelCube, FBModelMarker, FBModelNull, FBModelOptical, FBModelPath3D, FBModelPlane, FBModelRoot, FBModelSkeleton, FBNote, FBPhysicalProperties, FBSet, FBShader, FBShaderLighted, FBShaderShadowLive, FBTexture, FBUserObject, FBVideo, FBVideoClip, and FBVideoClipImage.
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.
pEvaluateInfo | Information concerning the evaluation of the animation (time, etc.) |
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.
pAnimationNode | Node containing the modified information. |
pEvaluateInfo | Information concerning the evaluation of the animation (time, etc.) |
Reimplemented in FBDevice, and FBDeviceOptical.
bool AnimationNodeDestroy | ( | FBAnimationNode | pAnimationNode | ) |
Destroy an animation node.
pAnimationNode | Handle to the animation node to be destroyed. |
bool AnimationNodeIsUserData | ( | FBAnimationNode | pAnimationNode | ) |
Is the animation node user data?.
pAnimationNode | Handle to the animation to be queried. |
AnimationNodesOutDisableIfNotWritten | ( | FBEvaluateInfo | pEvaluateInfo | ) |
This call will disable all out animation nodes from being pull by system (animation thread) for given pEvaluateInfo.
pEvaluateInfo | Evaluation synchronization object (contains evaluation id). |
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 | ) |
Reimplemented from FBComponent.
Reimplemented in FBCharacter, FBCharacterFace, FBConstraint, FBDevice, and FBShader.
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?.