Used to work with character poses. More...
#include <fbcharacterpose.h>
Public Member Functions | |
FBCharacterPose (const char *pName, HIObject pObject=NULL) | |
Public constructor. | |
void | ClearPose () |
Clear all the data of the pose. | |
void | ClearCharacterPose () |
Clear only the pose of the character (omit the extensions). | |
void | ClearCharacterExtensionsPose () |
Clear only the pose of the character extensions (omit the character). | |
void | CopyPose (FBCharacter &pCharacter) |
Copy the pose of a character and its extensions. | |
void | CopyPoseCharacter (FBCharacter &pCharacter) |
Copy the pose of only the character (omit the extensions). | |
void | CopyPoseCharacterExtensions (FBCharacter &pCharacter) |
Copy the pose of only the character extensions (omit the character). | |
void | CopyPoseCharacterExtension (FBCharacterExtension &pCharacterExtension) |
Copy the pose of a single character extension. | |
void | PastePose (FBCharacter &pCharacter, FBCharacterPoseOptions &pCharacterPoseOptions) |
Paste the pose of a character and its extensions. | |
void | PastePoseCharacter (FBCharacter &pCharacter, FBCharacterPoseOptions &pCharacterPoseOptions) |
Paste the pose of only the character (omit the extensions). | |
void | PastePoseCharacterExtensions (FBCharacter &pCharacter, FBCharacterPoseOptions &pCharacterPoseOptions) |
Paste the pose of only the character extensions (omit the character). | |
void | PastePoseCharacterExtension (FBCharacterExtension &pCharacterExtension, FBCharacterPoseOptions &pCharacterPoseOptions) |
Paste the pose of a single character extension. | |
bool | IsCharacterPoseStored () |
Is the pose of the character stored in the pose? | |
bool | IsCharacterExtensionPoseStored (const char *pCharacterExtensionName) |
Is the pose of the character extension stored in the pose? | |
void | CopyFrom (FBCharacterPose &pFromPose) |
Copy everything from a given object. | |
void | CopyPoseDataFrom (FBCharacterPose &pFromPose) |
Copy all the pose data from a given pose. | |
void | CopyPoseCharacterFrom (FBCharacterPose &pFromPose) |
Copy the pose data of only the character from a given pose. | |
void | CopyPoseCharacterExtensionsFrom (FBCharacterPose &pFromPose) |
Copy the pose data of only the character extensions from a given pose. | |
int | GetCharacterExtensionPoseCount () |
Get the number of character extension stored in the pose. | |
FBObjectPose * | GetCharacterExtensionPoseAt (int pIndex) |
Get the pose of a character extension. | |
FBObjectPose * | GetCharacterExtensionPose (const char *pCharacterExtensionName) |
Get the pose of a character extension. | |
FBObjectPose * | GetOrCreateCharacterExtensionPose (const char *pCharacterExtensionName) |
Get the pose of a character extension and create it if necessary. | |
void | RemoveCharacterExtensionPoseAt (int pIndex) |
Remove the pose of a character extension. | |
void | RemoveCharacterExtensionPose (const char *pCharacterExtensionName) |
Remove the pose of a character extension. | |
FBString | GetCharacterExtensionNameFromPose (FBObjectPose &pCharacterExtensionPose) |
Get the name of the character extension for the specified pose. | |
void | GetMirrorPlaneEquation (FBVector4< double > &pMirrorPlaneEquation, FBCharacter &pCharacter, FBCharacterPoseOptions &pCharacterPoseOptions) |
Get the mirror plane equation that would be used to mirror according to the CharacterPoseOptions. | |
void | GetMirrorPlaneEquation (FBMatrix &pMirrorPlaneEquation, FBCharacter &pCharacter, FBCharacterPoseOptions &pCharacterPoseOptions) |
Get the mirror plane equation that would be used to mirror according to the CharacterPoseOptions. | |
int | GetExtraBoneCount () |
Get the number of extra bones contained in the character pose. | |
FBModel * | GetExtraBoneModelAt (int pIndex) |
Get the extra bone model at the specified index. | |
void | GetExtraBoneTransformOffset (FBVector3d &pT, FBVector3d &pR, FBVector3d &pS, int pIndex) |
Get the extra bone transformation offset. | |
void | GetExtraBoneTransform (FBVector3d &pT, FBVector3d &pR, FBVector3d &pS, int pIndex) |
Get the extra bone transformation. | |
void | GetExtraBoneParentRotationOffset (FBRVector &pR, int pIndex) |
Get the extra bone transformation offset. | |
void | ApplyPoseCandidate () |
After setting the candidate on the skeleton node, calling this function will allow subsequent call to get the TRS value of a skeleton node to return the candidate value. | |
![]() | |
FBPose (const char *pName, HIObject pObject=NULL) | |
Constructor. | |
IQuery_Declare (override) | |
int | GetNodeCount () |
Returns the number of pose nodes stored. | |
int | AddNode (FBModel *pObject, FBMatrix *pMatrix=NULL, bool pIsLocalMatrix=false) |
Add a new pose node. | |
void | RemoveNode (int pIndex) |
Remove the pose node at specified index. | |
void | SetNodeObject (int pIndex, FBModel *pObject) |
Set the pose node object. | |
FBModel * | GetNodeObject (int pIndex) |
Get the pose node object. | |
FBString | GetNodeName (int pIndex) const |
Get the pose node at specified index. | |
void | SetNodeMatrix (int pIndex, FBMatrix *pMatrix) |
Set the pose node matrix. | |
FBMatrix | GetNodeMatrix (int pIndex) const |
Get the pose node matrix. | |
FBMatrix | GetNodeMatrixGlobal (int pIndex) const |
Get the global pose node matrix. | |
void | SetIsNodeLocalMatrix (int pIndex, bool pIsNodeLocalMatrix) |
Set the type of the Matrix for a given node. | |
bool | IsNodeLocalMatrix (int pIndex) |
Get the type of the Matrix for a given node. | |
int | Find (FBString pNodeName) |
Look in this pose if the given node is present. | |
void | CreatePoseThumbnail () |
Create an image thumbnail for the current pose. | |
![]() | |
FBComponent (HIObject pObject) | |
Constructor. | |
virtual | ~FBComponent () |
Destructor. | |
virtual bool | FBCreate () |
Open Reality Creation function. | |
virtual void | FBDestroy () |
Open Reality destruction function. | |
virtual void | FBDelete () override |
Open Reality deletion function. | |
virtual bool | SetHIObject (HIObject pObject, bool pSDKComponent) override |
Assign component to an internal pointer. | |
virtual int | PropertyAdd (FBProperty *pProperty) |
Add a property to the component's property manager. | |
bool | PropertyAddReferenceProperty (FBProperty *pReferenceProperty) |
Add a reference property to the component's property manager. | |
void | PropertyRemove (FBProperty *pProperty) |
Remove a Property from the component's Property manager. | |
void | PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags) |
Get list of properties which have been modified since last loading. | |
FBProperty * | PropertyCreate (const char *pName, FBPropertyType pType, const char *pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL) |
Create user or dynamic property. | |
FBObjectFlag | GetObjectFlags () |
Get all Object Flags (concatenated). | |
void | SetObjectFlags (FBObjectFlag pFlags) |
SetObjectFlags. | |
bool | HasObjectFlags (FBObjectFlag pFlags) |
Check whether a specific object flag is enabled. | |
void | EnableObjectFlags (FBObjectFlag pFlags) |
Enable a specific Object Flags. | |
void | DisableObjectFlags (FBObjectFlag pFlags) |
Disable a specific Object Flags. | |
void | SetObjectStatus (FBObjectStatus pStatus, bool pValue) |
Enable/Disable a specific Object Status. | |
bool | GetObjectStatus (FBObjectStatus pStatus) |
Check to see if an object status is enabled. | |
bool | ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char *pNamespaceName, const char *pReplaceTo=NULL, bool pAddRight=true) |
ProcessNamespaceHierarchy. | |
bool | ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char *pNamespaceName, const char *pReplaceTo=NULL, bool pAddRight=true) |
ProcessObjectNamespace. | |
virtual const char * | ClassName () override |
Get the class name. | |
virtual bool | UseCustomPropertyViewSet () const |
Use the custom property viewSet or not. | |
const char * | GetFullName (void) |
Get the full name. | |
void | SetOwnerNamespace (FBNamespace *pOwnerNSObj) |
Set the owner Namespace object. | |
FBNamespace * | GetOwnerNamespace (void) |
Get the owner Namespace object. | |
FBFileReference * | GetOwnerFileReference (void) |
Get the owner FileReference object. | |
void | HardSelect () |
HardSelect. | |
virtual bool | Is (int pTypeId) override |
Returns true if object is of type TypeId. | |
virtual int | GetTypeId () override |
GetTypeId( int pTypeId ) | |
![]() | |
FBScriptWrapper * | GetWrapper () |
Return the wrapper interface of this FBObject. | |
void | AddWrapper (FBScriptWrapper *) |
void | RemoveWrapper (FBScriptWrapper *) |
Additional Inherited Members | |
![]() | |
static int | GetInternalClassId () |
static void | FBComponentSetName (FBComponent *pObject, const char *pName) |
static const char * | FBComponentGetName (FBComponent *pObject) |
static void | FBComponentSetLongName (FBComponent *pObject, const char *pName) |
static const char * | FBComponentGetLongName (FBComponent *pObject) |
![]() | |
FBPropertyPoseType | Type |
Read Only Property: Type of the pose (bind pose or rest pose) | |
![]() | |
FBPropertyManager | PropertyList |
Read Only Property: Manages all of the properties for the component. | |
FBPropertyListComponent | Components |
List: List of components. | |
FBPropertyListComponent | Parents |
List: Parents. | |
FBPropertyBool | Selected |
Read Write Property: Selected property. | |
FBPropertyString | Name |
Read Write Property: Unique name of object. | |
FBPropertyString | LongName |
Read Write Property: Name and namespace for object. | |
FBPropertyFolder | Folder |
Read Write Property: The folder that contain this component. | |
![]() | |
static int | TypeInfo |
Contains the Type information of the object. | |
![]() | |
bool | IsSDKComponent () |
Return whether or not item is an SDK component. | |
bool | ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone) |
Add a source connection. | |
bool | ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone) |
Add a destination connection. | |
bool | ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone) |
Add a source connection. | |
bool | ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone) |
Add a destination connection. | |
bool | DisconnectDst (FBPlug *pDst) |
Remove a destination connection. | |
bool | DisconnectSrc (FBPlug *pSrc) |
Remove a source connection. | |
void | DisconnectAllSrc () |
Remove all source connections. | |
void | DisconnectAllDst () |
Remove all destination connections. | |
bool | DisconnectDstAt (int pIndex) |
Remove a destination connection at a specified index. | |
bool | DisconnectSrcAt (int pIndex) |
Remove a source connection at a specified index. | |
bool | ReplaceDstAt (int pIndex, FBPlug *pDst) |
Replace a destination connection at a specified index. | |
bool | ReplaceSrcAt (int pIndex, FBPlug *pSrc) |
Replace a source connection at a specified index. | |
bool | SwapSrc (int pIndexA, int pIndexB) |
Swap source connection at index A with source connection at index B. | |
bool | MoveSrcAt (int pIndex, int pAtIndex) |
Move source connection at pIndex to pAtIndex. | |
bool | MoveSrcAt (FBPlug *pSrc, FBPlug *pAtSrc) |
Move source connection pSrc to the position of pAtSrc. | |
int | GetSrcCount () |
Get source connection count. | |
FBPlug * | GetSrc (int pIndex) |
Get a source connection's plug at specified index. | |
FBConnectionType | GetSrcType (int pIndex) |
Get a source connection's type at specified index. | |
int | GetDstCount () |
Get destination connection count. | |
FBPlug * | GetDst (int pIndex) |
Get a destination connection's plug at specified index. | |
FBConnectionType | GetDstType (int pIndex) |
Get a destination connection's type at specified index. | |
bool | BeginChange () |
Begins a change on multiple plugs. | |
void | EndChange () |
Ends a change on multiple plugs. | |
void | SetSelfModified (FBPlugModificationFlag pFlag, bool pBool) |
Set the plug's self modification flag. | |
bool | GetSelfModified (FBPlugModificationFlag pFlag) |
Tell if the plug's self has changed. | |
void | SetContentModified (FBPlugModificationFlag pFlag, bool pBool) |
Set the plug's owned property/object's modification flag. | |
bool | GetContentModified (FBPlugModificationFlag pFlag) |
Tell if the plug's content has changed. | |
int | GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove) |
Get plug's modified src/dst property/object connection added/removed List. | |
bool | RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask) |
Revert the plug's modification to original status. | |
void | SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue) |
Set the plug's status flag. | |
bool | GetStatusFlag (FBPlugStatusFlag pStatus) const |
Tell if the plug's status has changed. | |
FBPlug * | GetOwner () |
Get the owner of this plug. | |
FBPlug * | GetOwned (int pIndex) |
Get the owned plug at specified index. | |
int | GetOwnedCount () |
Get the owned plug count. | |
virtual const char * | ClassName () |
internal System vars. | |
virtual bool | Is (int pTypeId) |
Is( int pTypeId ) | |
virtual int | GetTypeId () |
GetTypeId( int pTypeId ) | |
virtual bool | PlugDataNotify (FBConnectionAction pAction, FBPlug *pThis, void *pData=NULL, void *pDataOld=NULL, int pDataSize=0) |
PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only. | |
virtual bool | PlugStateNotify (FBConnectionAction pAction, FBPlug *pThis, void *pData=NULL, void *pDataOld=NULL, int pDataSize=0) |
PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only. | |
virtual bool | PlugNotify (FBConnectionAction pAction, FBPlug *pThis, int pIndex, FBPlug *pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL) |
PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only. | |
virtual void | FBDelete () |
Actual destructor for a FBPlug. | |
![]() | |
static int | GetInternalClassId () |
Internal class Id. | |
![]() | |
bool | mAllocated |
Contain the Allocation State of the Component. | |
HIObject | mObject |
Handle on the Plug. | |
bool | mSDKComponent |
bool Plug is an SDK component. | |
![]() | |
static const char * | ClassGroupName |
ClassGroupName of the object. | |
static int | TypeInfo |
TypeInfo. | |
static int | mGlobalTypeInfo |
Represente the Type Index. | |
Used to work with character poses.
This class exposes the object used to store the pose of objects.
Definition at line 180 of file fbcharacterpose.h.
FBCharacterPose | ( | const char * | pName, |
HIObject | pObject = NULL |
||
) |
Public constructor.
This constructor is used to create a new object.
pName | Object name. |
pObject | For internal use only. |
void ApplyPoseCandidate | ( | ) |
After setting the candidate on the skeleton node, calling this function will allow subsequent call to get the TRS value of a skeleton node to return the candidate value.
void ClearCharacterExtensionsPose | ( | ) |
Clear only the pose of the character extensions (omit the character).
void ClearCharacterPose | ( | ) |
Clear only the pose of the character (omit the extensions).
void ClearPose | ( | ) |
Clear all the data of the pose.
void CopyFrom | ( | FBCharacterPose & | pFromPose | ) |
Copy everything from a given object.
pFromPose | Pose from which to copy. |
void CopyPose | ( | FBCharacter & | pCharacter | ) |
Copy the pose of a character and its extensions.
pCharacter | Character to copy the pose from. |
void CopyPoseCharacter | ( | FBCharacter & | pCharacter | ) |
Copy the pose of only the character (omit the extensions).
pCharacter | Character to copy the pose from. |
void CopyPoseCharacterExtension | ( | FBCharacterExtension & | pCharacterExtension | ) |
Copy the pose of a single character extension.
pCharacterExtension | Character extension to copy the pose from. |
void CopyPoseCharacterExtensions | ( | FBCharacter & | pCharacter | ) |
Copy the pose of only the character extensions (omit the character).
pCharacter | Character to copy the pose of the extensions from. |
void CopyPoseCharacterExtensionsFrom | ( | FBCharacterPose & | pFromPose | ) |
Copy the pose data of only the character extensions from a given pose.
pFromPose | Pose from which to copy the data. |
void CopyPoseCharacterFrom | ( | FBCharacterPose & | pFromPose | ) |
Copy the pose data of only the character from a given pose.
pFromPose | Pose from which to copy the data. |
void CopyPoseDataFrom | ( | FBCharacterPose & | pFromPose | ) |
Copy all the pose data from a given pose.
pFromPose | Pose from which to copy the data. |
FBString GetCharacterExtensionNameFromPose | ( | FBObjectPose & | pCharacterExtensionPose | ) |
Get the name of the character extension for the specified pose.
pCharacterExtensionPose | Pose of a character extension to check its name. |
FBObjectPose * GetCharacterExtensionPose | ( | const char * | pCharacterExtensionName | ) |
Get the pose of a character extension.
pCharacterExtensionName | Name of the character extension pose to get (It is the label name of the character extension). |
FBObjectPose * GetCharacterExtensionPoseAt | ( | int | pIndex | ) |
Get the pose of a character extension.
pIndex | Index of the character extension pose to get. |
int GetCharacterExtensionPoseCount | ( | ) |
Get the number of character extension stored in the pose.
int GetExtraBoneCount | ( | ) |
Get the number of extra bones contained in the character pose.
FBModel * GetExtraBoneModelAt | ( | int | pIndex | ) |
Get the extra bone model at the specified index.
pIndex | Index of the extra bone to get. |
void GetExtraBoneParentRotationOffset | ( | FBRVector & | pR, |
int | pIndex | ||
) |
Get the extra bone transformation offset.
pR | A vector that will contains the parent rotation offset value on return. |
pIndex | Index of the extra bone to get. |
void GetExtraBoneTransform | ( | FBVector3d & | pT, |
FBVector3d & | pR, | ||
FBVector3d & | pS, | ||
int | pIndex | ||
) |
Get the extra bone transformation.
pT | A vector that will contains the translation value on return. |
pR | A vector that will contains the rotation value on return. |
pS | A vector that will contains the scale value on return. |
pIndex | Index of the extra bone to get. |
void GetExtraBoneTransformOffset | ( | FBVector3d & | pT, |
FBVector3d & | pR, | ||
FBVector3d & | pS, | ||
int | pIndex | ||
) |
Get the extra bone transformation offset.
pT | A vector that will contains the translation offset value on return. |
pR | A vector that will contains the rotation offset value on return. |
pS | A vector that will contains the scale offset value on return. |
pIndex | Index of the extra bone to get. |
void GetMirrorPlaneEquation | ( | FBMatrix & | pMirrorPlaneEquation, |
FBCharacter & | pCharacter, | ||
FBCharacterPoseOptions & | pCharacterPoseOptions | ||
) |
Get the mirror plane equation that would be used to mirror according to the CharacterPoseOptions.
pMirrorPlaneEquation | Out: Mirror plane equation. |
pCharacter | Character to receive the pose. |
pCharacterPoseOptions | Options used to paste the pose. |
void GetMirrorPlaneEquation | ( | FBVector4< double > & | pMirrorPlaneEquation, |
FBCharacter & | pCharacter, | ||
FBCharacterPoseOptions & | pCharacterPoseOptions | ||
) |
Get the mirror plane equation that would be used to mirror according to the CharacterPoseOptions.
pMirrorPlaneEquation | Out: Mirror plane equation. |
pCharacter | Character to receive the pose. |
pCharacterPoseOptions | Options used to paste the pose. |
FBObjectPose * GetOrCreateCharacterExtensionPose | ( | const char * | pCharacterExtensionName | ) |
Get the pose of a character extension and create it if necessary.
pCharacterExtensionName | Name of the character extension pose to get (It is the label name of the character extension). |
bool IsCharacterExtensionPoseStored | ( | const char * | pCharacterExtensionName | ) |
Is the pose of the character extension stored in the pose?
pCharacterExtensionName | Name of the character extension. |
bool IsCharacterPoseStored | ( | ) |
Is the pose of the character stored in the pose?
void PastePose | ( | FBCharacter & | pCharacter, |
FBCharacterPoseOptions & | pCharacterPoseOptions | ||
) |
Paste the pose of a character and its extensions.
pCharacter | Character to paste the pose to. |
pCharacterPoseOptions | Options used to specify how to paste. |
void PastePoseCharacter | ( | FBCharacter & | pCharacter, |
FBCharacterPoseOptions & | pCharacterPoseOptions | ||
) |
Paste the pose of only the character (omit the extensions).
pCharacter | Character to paste the pose to. |
pCharacterPoseOptions | Options used to specify how to paste. |
void PastePoseCharacterExtension | ( | FBCharacterExtension & | pCharacterExtension, |
FBCharacterPoseOptions & | pCharacterPoseOptions | ||
) |
Paste the pose of a single character extension.
pCharacterExtension | Character extension to paste the pose to. |
pCharacterPoseOptions | Options used to specify how to paste. |
void PastePoseCharacterExtensions | ( | FBCharacter & | pCharacter, |
FBCharacterPoseOptions & | pCharacterPoseOptions | ||
) |
Paste the pose of only the character extensions (omit the character).
pCharacter | Character to paste the pose of the extensions to. |
pCharacterPoseOptions | Options used to specify how to paste. |
void RemoveCharacterExtensionPose | ( | const char * | pCharacterExtensionName | ) |
Remove the pose of a character extension.
pCharacterExtensionName | Name of the character extension pose to remove (It is the label name of the character extension). |
void RemoveCharacterExtensionPoseAt | ( | int | pIndex | ) |
Remove the pose of a character extension.
pIndex | Index of the character extension pose to remove. |