ISkin Class Reference

#include <iskin.h>

Inheritance diagram for ISkin:

Public Member Functions
virtual	~ISkin ()
virtual int	GetBoneInitTM (INode *pNode, Matrix3 &InitTM, bool bObjOffset=false)=0
virtual int	GetSkinInitTM (INode *pNode, Matrix3 &InitTM, bool bObjOffset=false)=0
virtual int	GetNumBones ()=0
virtual INode *	GetBone (int idx)=0
virtual DWORD	GetBoneProperty (int idx)=0
virtual ISkinContextData *	GetContextInterface (INode *pNode)=0
virtual const MCHAR *	GetBoneName (int index)=0
virtual int	GetSelectedBone ()=0
virtual void	UpdateGizmoList ()=0
virtual void	GetEndPoints (int id, Point3 &l1, Point3 &l2)=0
virtual Matrix3	GetBoneTm (int id)=0
virtual INode *	GetBoneFlat (int idx)=0
virtual int	GetNumBonesFlat ()=0
virtual int	GetRefFrame ()=0
virtual BOOL	GetDQBlending ()=0
virtual void	SetDQBlending (BOOL blend)=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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator.
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator.
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary.
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary.
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.

Detailed Description

See also

Class ISkinContextData, Class INode, Class Matrix3

Description:

This class represents the interface for the Skin modifier.

Constructor & Destructor Documentation

~ISkin()

virtual ~ISkin ( )

inlinevirtual

Remarks

Destructor.

{}

Member Function Documentation

GetBoneInitTM()

virtual int GetBoneInitTM ( INode *  pNode, Matrix3 &  InitTM, bool  bObjOffset = false  )

pure virtual

Remarks

This method retrieves the intial matrix of the bone when it was applied to skin.

Parameters:

INode *pNode

The INode of the bone you want to get the TM from.

Matrix3 &InitTM

This returns either the initial node TM or object TM of the bone when it was applied to skin.

bool bObjOffset = false

When TRUE the InitTM returns the object TM else the node TM.

Returns

SKIN_OK if the pNode was in the system else it returns SKIN_INVALID_NODE_PTR.

GetSkinInitTM()

virtual int GetSkinInitTM ( INode *  pNode, Matrix3 &  InitTM, bool  bObjOffset = false  )

pure virtual

Remarks

This method gets the initial matrix of the skinned object when it was applied to skin.

Parameters:

INode *pNode

The INode of the bone you want to get the TM from.

Matrix3 &InitTM

This returns either the initial skinned node tm or object tm of the bone when it was applied to skin.

bool bObjOffset = false

When TRUE the InitTM returns the object TM else the node TM.

Returns

SKIN_OK if the pNode was in the system else it returns SKIN_INVALID_NODE_PTR.

GetNumBones()

virtual int GetNumBones ( )

pure virtual

Remarks

This method returns the actual number of non NULL bones in the system.

GetBone()

virtual INode * GetBone ( int  idx )

pure virtual

Remarks

This method returns the INode of a particular bone.

Parameters:

int idx

The index of the bone that you want to get the INode from. Note there are 2 tables that contain bone date. One has NULL entries and the other has all the invalid NULL bones removed. The index here points to the table that has the NULL entries removed.

GetBoneProperty()

virtual DWORD GetBoneProperty ( int  idx )

pure virtual

Remarks

This method returns the flags of a particular bone.

Parameters:

int idx

The index of the bone that you want to get the INode from. Note there are 2 tables that contain bone data. One has NULL entries and the other has all the invalid NULL bones removed. The index here points to the table that has the NULL entries removed.

Returns

One of the following;

BONE_LOCK_FLAG

Not used.

BONE_ABSOLUTE_FLAG

The bone is in absolute mode (i.e. all the vertices weight must add up to 1.0f).

BONE_SPLINE_FLAG

This bone is a spline.

BONE_SPLINECLOSED_FLAG

This bone is a closed spline.

BONE_DRAW_ENVELOPE_FLAG

Always draw this bones envelope.

BONE_BONE_FLAG

This bone is one of 3ds Max' bone objects..

BONE_DEAD_FLAG

This bone is no longer used.

GetContextInterface()

virtual ISkinContextData * GetContextInterface ( INode *  pNode )

pure virtual

Remarks

This method returns the interface pointer to the local skin data for the node.

Parameters:

INode *pNode

The node that you want to retrieve the skin interface to.

GetBoneName()

virtual const MCHAR * GetBoneName ( int  index )

pure virtual

Remarks

This method returns the name of the bone pointed to by index.

Parameters:

int index

The index of the bone that you want to get the name of. Note there are 2 tables that contain bone data. One has NULL entries and the other has all the invalid NULL bones removed. The index here points to the table that has the NULL entries in them.

GetSelectedBone()

virtual int GetSelectedBone ( )

pure virtual

Remarks

This method returns the current selected bone.

UpdateGizmoList()

virtual void UpdateGizmoList ( )

pure virtual

Remarks

This method forces the gizmo list box to update.

GetEndPoints()

virtual void GetEndPoints ( int  id, Point3 &  l1, Point3 &  l2  )

pure virtual

Remarks

This method retrieves the start and end points of the envelope in bone space.

Parameters:

int id

The index of the bone that you want to get the INode from. Note there are 2 tables that contain bone data. One has NULL entries and the other has all the invalid NULL bones removed. The index here points to the table that has the NULL entries

Point3 &l1

The start point of the envelope in bone space.

Point3 &l2

The end point of the envelope in bone space.

GetBoneTm()

virtual Matrix3 GetBoneTm ( int  id )

pure virtual

Remarks

This method returns the bone TM of the specified bone.

Parameters:

int id

The index of the bone.

GetBoneFlat()

virtual INode * GetBoneFlat ( int  idx )

pure virtual

Remarks

This method returns the INode of a particular bone.

Parameters:

int idx

The index of the bone that you want to get the INode from. Note there are 2 tables that contain bone data. One has NULL entries and the other has all the invalid NULL bones removed. The index here points to the table that has the NULL entries

GetNumBonesFlat()

virtual int GetNumBonesFlat ( )

pure virtual

Remarks

This method returns the actual number of NULL bones in the system including NULL entries.

GetRefFrame()

virtual int GetRefFrame ( )

pure virtual

Remarks

This returns the reference frame of the skin modifier.

GetDQBlending()

virtual BOOL GetDQBlending ( )

pure virtual

Remarks

Returns whether the skin modifier is in DQ blending mode

SetDQBlending()

virtual void SetDQBlending ( BOOL  blend )

pure virtual

Remarks

Sets whether the skin modifier is in DQ blending mode