Detailed Description
- See also:
- Class ISkin
- Description:
- This class is available in release 4.0 and later only.
This class represents the interface that allows you to get at the local modifier data for skin. The data is stored in the form of vertex weight arrays. Each vertex has an array of boneID's and weights which affect that particular vertex.
#include <iskin.h>
Inheritance diagram for
ISkinContextData:
Public Member Functions |
|
| virtual | ~ISkinContextData () |
| virtual int | GetNumPoints ()=0 |
| virtual int | GetNumAssignedBones (int vertexIdx)=0 |
| virtual int | GetAssignedBone (int vertexIdx, int boneIdx)=0 |
| virtual float | GetBoneWeight (int vertexIdx, int boneIdx)=0 |
| virtual int | GetSubCurveIndex (int vertexIdx, int boneIdx)=0 |
| virtual int | GetSubSegmentIndex (int vertexIdx, int boneIdx)=0 |
| virtual float | GetSubSegmentDistance (int vertexIdx, int boneIdx)=0 |
| virtual Point3 | GetTangent (int vertexIdx, int boneIdx)=0 |
| virtual Point3 | GetOPoint (int vertexIdx, int boneIdx)=0 |
Constructor & Destructor Documentation
| virtual ~ISkinContextData | ( | ) | [inline, virtual] |
- Remarks:
- Destructor.
{}
Member Function Documentation
| virtual int GetNumPoints | ( | ) | [pure virtual] |
- Remarks:
- This method returns the number of points that skin affects.
| virtual int GetNumAssignedBones | ( | int | vertexIdx | ) | [pure virtual] |
- Remarks:
- This method returns the number of bones that control this vertex.
- Parameters:
- int vertexIdx
The index into the vertex array.
| virtual int GetAssignedBone | ( | int | vertexIdx, |
| int | boneIdx | ||
| ) | [pure virtual] |
- Remarks:
- This method returns the index of the bone that affecting the vertex
- Parameters:
- int vertexIdx
The index into the vertex array.
int boneIdx
The index into the affected bone array for that vertex.
| virtual float GetBoneWeight | ( | int | vertexIdx, |
| int | boneIdx | ||
| ) | [pure virtual] |
- Remarks:
- This method returns the weight that is affecting the vertex
- Parameters:
- int vertexIdx
The index into the vertex array.
int boneIdx
The index into the affected bone array for that vertex.
| virtual int GetSubCurveIndex | ( | int | vertexIdx, |
| int | boneIdx | ||
| ) | [pure virtual] |
- Remarks:
- This method currently returns 0 since the only the first curve is used in for spline animation.
- Parameters:
- int vertexIdx
The index into the vertex array.
int boneIdx
The index into the affected bone array for that vertex.
| virtual int GetSubSegmentIndex | ( | int | vertexIdx, |
| int | boneIdx | ||
| ) | [pure virtual] |
- Remarks:
- This method returns the segment that of the spline that is affecting the vertex.
- Parameters:
- int vertexIdx
The index into the vertex array.
int boneIdx
The index into the affected bone array for that vertex.
| virtual float GetSubSegmentDistance | ( | int | vertexIdx, |
| int | boneIdx | ||
| ) | [pure virtual] |
- Remarks:
- This method returns how far away the point was initially from the curve.
- Parameters:
- int vertexIdx
The index into the vertex array.
int boneIdx
The index into the affected bone array for that vertex.
| virtual Point3 GetTangent | ( | int | vertexIdx, |
| int | boneIdx | ||
| ) | [pure virtual] |
- Remarks:
- This method returns closest initial tangent to the vertex.
- Parameters:
- int vertexIdx
The index into the vertex array.
int boneIdx
The index into the affected bone array for that vertex.
| virtual Point3 GetOPoint | ( | int | vertexIdx, |
| int | boneIdx | ||
| ) | [pure virtual] |
- Remarks:
- This method returns closest initial point on the curve to the vertex.
- Parameters:
- int vertexIdx
The index into the vertex array.
int boneIdx
The index into the affected bone array for that vertex.
