ISkinImportData Class Reference

#include <iskin.h>

Class Description

class ISkinImportData

Description:

The interface that allows to import data: bones, initial skin and bone transforms, and vertex weighting into skin.

Inheritance diagram for ISkinImportData:

Public Member Functions
virtual	~ISkinImportData ()
virtual BOOL	AddBoneEx (INode *boneNode, BOOL update)=0
virtual BOOL	SetSkinTm (INode *skinNode, Matrix3 objectTm, Matrix3 nodeTm)=0
virtual BOOL	SetBoneTm (INode *boneNode, Matrix3 objectTm, Matrix3 nodeTm)=0
virtual BOOL	AddWeights (INode *skinNode, int vertexID, Tab< INode * > &boneNodeList, Tab< float > &weights)=0

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator. More...
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary. More...
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...

Constructor & Destructor Documentation

virtual ~ISkinImportData ( )

inlinevirtual

Remarks

Destructor.

{}

Member Function Documentation

virtual BOOL AddBoneEx ( INode *  boneNode, BOOL  update  )

pure virtual

Remarks

Adds a bone to the skin system

Parameters:

INode *node

The bone to be added to skin.

BOOL update

The flag for UI update

Returns

TRUE if the operation succeeded.

virtual BOOL SetSkinTm ( INode *  skinNode, Matrix3  objectTm, Matrix3  nodeTm  )

pure virtual

Remarks

When skin is applied to a node, that nodes initial ObjectTM is stored off, so the initial position of the skin object can be recomputed. The function allows to set that TM. Stores TM and the inverse TM of the matrix passed to it.

Parameters:

INode *skinNode

The node that Skin is applied to

Matrix3 objectTm

The object matrix to assign as the new Skin object TM.

Matrix3 nodeTm

The node matrix to assign as the new Skin node TM

Returns

TRUE if the operation succeeded.

virtual BOOL SetBoneTm ( INode *  boneNode, Matrix3  objectTm, Matrix3  nodeTm  )

pure virtual

Remarks

When a bone is added to skin it stores off the initial object and node TM of that bone. The function sets the initial matrix of a particular bone.

Parameters:

INode *boneNode

The pointer to the bone that is having its initial matrix change

Matrix3 objectTm

The object matrix to assign as the new Skin object TM.

Matrix3 nodeTm

The node matrix to assign as the new Skin node TM

Returns

TRUE if the operation succeeded.

virtual BOOL AddWeights ( INode *  skinNode, int  vertexID, Tab< INode * > &  boneNodeList, Tab< float > &  weights  )

pure virtual

Remarks

Adds weight to a specific vertex. Replaces the current vertex weight data supplied. The weights should sum to 1.0f. Both boneNodelist and weights must be the same size .

Parameters:

INode *skinNode

The node that has skin applied to it, used to obtain the local mod data for that node and skin since the same modifier can be applied to multiple nodes through instancing.

int vertexID

The index of the vertex to apply weights to.

Tab<INode*> &boneNodeList

The list of bones that will control the vertex, these must already be added to the skin modifier.

Tab<float> &weights

The weight of each bone.

Returns

TRUE if the operation succeeded.