IFXAuthorBones

IFXAuthorBones is a container class that should be given as an argument to the IFXAuthorGeomCompiler::Compile method to have bone-based character animation in a model resource.

Interface Methods

Description

SetBoneCount

Allocates the object

GetBoneCount

Returns the object storage capacity

SetBoneInfo

Puts data into one of the object storage slots

GetBoneInfo

Retrieves the information in one of the BoneInfo structures stored in the object

Clear

Deallocates all the BoneInfo data stored in the object


IFXAuthorBones:: SetBoneCount (U32 in_BoneCount)

This method allocates the number of Bone info data items that the IFXAuthorBones object can hold.

Parameters:

U32 in_BoneCount

The number of bones that the object is to hold.

Return Values

Comments

This should be called before any calls to SetBoneInfo or GetBoneInfo. It should be called again after a call to Clear.


IFXAuthorBones:: GetBoneCount ()

This method allocates the number of Bone info data items that the IFXAuthorBones object can hold.

Parameters:

None

Return Values

The current capacity of the IFXAuthorBones Object.

Comments

If this method is called after a Clear and/or before a call to SetBoneCount it will return 0.


IFXAuthorBones:: SetBoneInfo (U32 in_BoneID, IFXBoneInfo* in_pBoneInfo)

This method allows the Bone information to be set.

Parameters:

U32 in_BoneID

The ID or index of the BoneInfo Slot to Fill

IFXBoneInfo* in_pBoneInfo

The BoneInfo Data to put into the Slot

Return Values

Comments

This is the primary way of populating the IFXAuthorBones Object.


IFXAuthorBones:: GetBoneInfo (U32 in_BoneID)

This method allows the Bone information to be retrieved from a bone info object.

Parameters:

U32 in_BoneID

The id or index of the BoneInfo Item to return

Return Values

Comments

The pointer returned will be invalidated when a call to Clear, SetBoneCount, or the object is deallocated.


IFXAuthorBones:: Clear()

This method resets the object and deallocates all slots available for holding bone information.

Parameters:

None

Return Values

Comments

Useful if you want to reuse this object for multiple model resource generations.

§See asterisked (*) statement at Legal Information © 2001 Intel Corporation.