Detailed Description
- See also:
- Class ISkinContextData, Class
INode, Class Matrix3
- Description:
- This class is available in release 4.0 and later only.
This class represents the interface for the Skin modifier.
#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 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 |
Constructor & Destructor Documentation
| virtual ~ISkin | ( | ) | [inline, virtual] |
- Remarks:
- Destructor.
{}
Member Function Documentation
| 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.
| 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.
| virtual int GetNumBones | ( | ) | [pure virtual] |
- Remarks:
- This method returns the actual number of non NULL bones in the system.
| 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.
| 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.
| 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.
| virtual 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.
| virtual int GetSelectedBone | ( | ) | [pure virtual] |
- Remarks:
- This method returns the current selected bone.
| virtual void UpdateGizmoList | ( | ) | [pure virtual] |
- Remarks:
- This method forces the gizmo list box to update.
- 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.
| 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.
| 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
| virtual int GetNumBonesFlat | ( | ) | [pure virtual] |
- Remarks:
- This method returns the actual number of NULL bones in the system including NULL entries.
| virtual int GetRefFrame | ( | ) | [pure virtual] |
- Remarks:
- This returns the reference frame of the skin modifier.
