FBBox Class Reference
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.
Public Member Functions |
|
| HFBAnimationNode | AnimationNodeInCreate (int pUserId, str pName, str pDataType, bool pIsPublic=False, float pMin=None, float pMax=None, bool pUserData=False) |
| Creation of IN/OUT Animation Nodes. |
|
| HFBAnimationNode | AnimationNodeOutCreate (int pUserId, str pName, str pDataType, bool pIsPublic=False, float pMin=None, float pMax=None, bool pUserData=False) |
| bool | FbxStore (HFBFbxObject pFbxObject, kFbxObjectStore pStoreWhat) |
| Storage/Retrieval of information into the
FBX file format. |
|
| bool | FbxRetrieve (HFBFbxObject pFbxObject, kFbxObjectStore pStoreWhat) |
| HFBAnimationNode | AnimationNodeInGet () |
| Get the (IN/OUT) animation node for this
box. |
|
| HFBAnimationNode | AnimationNodeOutGet () |
| __init__ (str pName, object pObject=None) | |
| Constructor. |
|
| bool | EvaluateAnimationNodes (HFBEvaluateInfo pEvaluateInfo) |
| Evaluation of non TRS nodes that needs to be
evaluated. |
|
| bool | AnimationNodeNotify (HFBAnimationNode pAnimationNode, HFBEvaluateInfo pEvaluateInfo) |
| Notification function for animation thread.
|
|
| bool | AnimationNodeDestroy (HFBAnimationNode pAnimationNode) |
| Destroy an animation node. |
|
| bool | AnimationNodeIsUserData (HFBAnimationNode pAnimationNode) |
| Is the animation node user data?. |
|
| str | FbxGetObjectSubType () |
| returns UniqueName if not overloaded.
|
|
| str | FbxGetObjectType () |
| Object Type "Box". |
|
| IObject_Declare (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
| HFBAnimationNode AnimationNodeInCreate | ( | int | pUserId, |
| str | pName, | ||
| str | pDataType, | ||
| bool | pIsPublic = False, |
||
| float | pMin = None, |
||
| float | pMax = None, |
||
| bool | pUserData =
False |
||
| ) |
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.
| HFBAnimationNode AnimationNodeOutCreate | ( | int | pUserId, |
| str | pName, | ||
| str | pDataType, | ||
| bool | pIsPublic = False, |
||
| float | pMin = None, |
||
| float | pMax = None, |
||
| bool | pUserData =
False |
||
| ) |
Reimplemented in FBDevice.
| bool FbxStore | ( | HFBFbxObject | pFbxObject, |
| kFbxObjectStore | pStoreWhat | ||
| ) |
Storage/Retrieval of information into the FBX file format.
- Parameters:
-
pFbxObject Object to interface with FBX file format. pStoreWhat Attributes to store in FBX file.
- Returns:
- true if successful.
Reimplemented in FBConstraint, FBDevice, FBDeviceOptical, FBModel, and FBUserObject.
| bool FbxRetrieve | ( | HFBFbxObject | pFbxObject, |
| kFbxObjectStore | pStoreWhat | ||
| ) |
Reimplemented in FBConstraint, FBDevice, FBDeviceOptical, FBModel, and FBUserObject.
| HFBAnimationNode AnimationNodeInGet | ( | ) |
Get the (IN/OUT) animation node for this box.
- Returns:
- A handle to the animation node for this box.
| HFBAnimationNode AnimationNodeOutGet | ( | ) |
Constructor.
- Parameters:
-
pName Box name. pObject For internal use only (default is NULL).
Reimplemented in FBActor, FBCamera, FBCameraStereo, FBCharacter, FBCharacterFace, FBConstraint, FBConstraintSolver, FBDevice, FBDeviceOptical, FBHandle, FBLayeredTexture, FBLight, FBMaterial, FBModel, FBModelCube, FBModelMarker, FBModelNull, FBModelOptical, FBModelPath3D, FBModelPlane, FBModelRoot, FBModelSkeleton, FBNote, FBPhysicalProperties, FBShader, FBShaderLighted, FBShaderShadowLive, FBTexture, FBUserObject, FBVideo, and FBVideoClip.
| bool EvaluateAnimationNodes | ( | HFBEvaluateInfo | 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:
-
pEvaluateInfo Information concerning the evaluation of the animation (time, etc.)
- Returns:
- true if animation node notification is successful.
| bool AnimationNodeNotify | ( | HFBAnimationNode | pAnimationNode, |
| HFBEvaluateInfo | pEvaluateInfo | ||
| ) |
Notification function for animation thread.
This function is called by the real-time engine in order to process animation information.
- Parameters:
-
pAnimationNode Node containing the modified information. pEvaluateInfo Information concerning the evaluation of the animation (time, etc.)
- Returns:
- true if animation node notification is successful.
Reimplemented in FBDevice, and FBDeviceOptical.
| bool AnimationNodeDestroy | ( | HFBAnimationNode | pAnimationNode | ) |
Destroy an animation node.
- Parameters:
-
pAnimationNode Handle to the animation node to be destroyed.
- Returns:
- true if destruction was successful.
| bool AnimationNodeIsUserData | ( | HFBAnimationNode | pAnimationNode | ) |
Is the animation node user data?.
- Parameters:
-
pAnimationNode Handle to the animation to be queried.
- Returns:
- true if node is user data.
| str FbxGetObjectSubType | ( | ) |
| str FbxGetObjectType | ( | ) |
| IObject_Declare | ( | Implementation | ) |
Reimplemented from FBComponent.
Reimplemented in FBCharacter, FBCharacterFace, FBConstraint, FBDevice, and FBShader.
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?.
