IFXAuthorMesh |
This class offers an authoring view, as opposed to a run-time view, of a 3-D mesh. This structure is easy to manipulate because it can contain faces that reference multiple materials and has vertex positions on material or attribute boundaries that are not replicated. As a result, this structure is not efficient for rendering until it is compiled into an IFXMesh structure.
Methods
|
Allocates all memory required by the mesh |
|
|
Releases allocated memory |
|
|
Gets the allocation descriptor |
|
|
Returns the current number of faces in the mesh |
|
|
Sets the current number of faces in the mesh and returns the number once set |
|
|
Sets an IFXAuthorFace structure to point to a specific face in the mesh |
|
|
Returns the current number of shaders |
|
|
Returns the current number of vertices in the mesh |
|
|
Sets the current number of vertices in the mesh and returns the number once set |
|
|
Returns a pointer to an IFXVector3 in the mesh that stores a position |
|
|
Returns the current number of normals in the mesh |
|
|
Returns the current number of normals in the mesh and returns the number once set |
|
|
Returns a pointer to an IFXVector3 in the mesh that stores a normal |
|
|
Returns the current number of vertex color layers in the mesh |
|
|
Returns the current number of vertex colors in the mesh |
|
|
Sets the current number of vertex colors in the mesh |
|
|
Returns a pointer to an IFXVector4 in the mesh that stores a vertex color |
|
|
Returns the current number of texture color layers in the mesh |
|
|
Returns the current number of texture coordinates |
|
|
Sets the current number of texture coordinates |
|
|
Returns a pointer to an IFXVector2 in the mesh that stores a texture coordinate |
|
|
Returns the number of user-defined vertex attributes in the mesh |
|
|
Sets the current number of user-defined vertex attributes in the mesh and returns the number once set |
|
|
Returns a pointer to an IFXGenericAttribute in the mesh that stores an attribute |
|
|
Returns the current number of user-defined face attributes in the mesh |
|
|
Sets the current number of user-defined face attributes in the mesh and returns the number once set |
|
|
Returns a pointer to an IFXGenericAttribute in the mesh that stores an attribute |
|
|
Returns IFXUVMap which stores the vertex map |
|
|
Sets IFXUVMap which stores the vertex map |
|
|
Returns whether there is a base vertex |
|
|
Sets a base vertex when there is one |
|
|
Returns the number of base vertices |
|
|
Sets the vertex weight count |
|
|
Sets the vertex weight value |
|
|
Returns the vertex weight count |
|
|
Returns the vertex weight value |
|
|
Gets the name of the mesh |
|
|
Sets the name of the mesh |
|
|
Gets the name of parent mesh |
|
|
Sets the name of the parent mesh |
This method allocates all memory required by the mesh.
Parameters:
|
pAllocDescriptor |
Pointer to the IFXAuthorAllocationDescriptor |
Comments:
Must be called after construction and prior to mesh usage.
This method frees all allocated memory. Called automatically by IFXAuthorMesh::Release(). Can be called to facilitate a reallocation prior to a send call to IFXAuthorMesh::Allocate().
Parameters:
None
This method accesses the IFXAuthorAllocationDescriptor.
Parameters:
|
pAllocDescriptor |
Pointer to the IFXAuthorAllocationDescriptor |
Return Values:
None
This method returns the current number of faces in the mesh.
Parameters:
None
Return Values:
IFXAuthorGeomIndex (Either U16 or U32 depending on compile flags.)
This method sets the current number of faces in the mesh and returns the number once set. Note that IFXAuthorGeomIndex is either U16 or U32 depending on compile flags.
Parameters:
|
U32 numberFaces |
Current number of faces |
Return Values:
IFXAuthorGeomIndex
This method sets an IFXAuthorFace structure to point to a specific face in the mesh. This method must be called for each face to be accessed. This method can be used for getting and setting the face.
Parameters:
|
U32 index |
Index of the specific face |
|
IFXAuthorFace pFace |
Pointer to the IFXAuthorFace |
This method returns the number of shaders associated with the mesh.
Parameters:
None
Return Values:
Integer
This method returns the current position of vertices in the mesh.
Parameters:
None
Return Values:
IFXAuthorGeomIndex (either U16 or U32 depending on compile flags.)
This method sets the current number of vertices in the mesh and returns the number once set. Note that IFXAuthorGeomIndex is either U16 or U32 depending on compile flags.
Parameters:
|
U32 numberVertices |
Current number of vertices |
Return Values:
IFXAuthorGeomIndex (either U16 or U32 depending on compile flags.)
This method returns a pointer to an IFXVector3 in the mesh that stores a position. GetPosition() must be called for each position to be accessed. This method can be used for getting and setting the position.
Parameters:
|
U32 index |
Index of the specific vertex |
Return Values:
IFXVector3*
This method returns the current position of normals in the mesh.
Parameters:
None
Return Values:
IFXAuthorGeomIndex (either U16 or U32 depending on compile flags.)
This method sets the current number of normals in the mesh and returns the number once set. IFXAuthorGeomIndex is either U16 or U32 depending on compile flags.
Parameters:
|
U32 numberVertices |
Current number of vertices |
Return Values:
IFXAuthorGeomIndex (either U16 or U32 depending on compile flags.)
This method returns a pointer to an IFXVector3 in the mesh that stores a normal. GetNormal() must be called for each normal to be accessed. This method can be used for getting and setting the normal.
Parameters:
|
U32 index |
Index of the specific vertex |
Return Values:
IFXVector3*
This method returns the current number of vertex color layers in the mesh.
Parameters:
None
Return Values:
Integer
This method returns the current number of vertex colors in the mesh.
Parameters:
|
U32 LayerNum=0 |
Defaults to layer 0 if no layer is specified |
Return Values:
IFXAuthorGeomIndex
This method sets the current number of vertex colors in the mesh and returns the number once set.
Parameters:
|
U32 numberVertices |
Current number of vertices |
|
U32 LayerNum=0 |
Defaults to layer 0 if no layer is specified |
Return Values:
IFXAuthorGeomIndex
This method returns a pointer to an IFXVector4 in the mesh that stores a vertex color. GetVertexColor() must be called for each color to be accessed. This method can be used for getting and setting the vertex color.
Parameters:
|
U32 index |
Index of the specific normal |
|
U32 LayerNum=0 |
Defaults to layer 0 if no layer is specified |
Return Values:
IFXVector4*
This method returns the current number of texture color layers in the mesh.
Parameters:
None
Return Values:
Integer
This method returns the current number of texture coordinates in the mesh.
Parameters:
|
U32 LayerNum=0 |
Defaults to layer 0 if no layer is specified |
Return Values:
IFXAuthorGeomIndex
This method sets the current number of texture coordinates in the mesh and returns the number once set.
Parameters:
|
U32 numberVertices |
Current number of vertices |
|
U32 LayerNum=0 |
Defaults to layer 0 if no layer is specified |
Return Values:
IFXAuthorGeomIndex
This method returns a pointer to an IFXVector2 in the mesh that stores a texture coordinate. GetTexCoord()must be called for each texture coordinate to be accessed. This method can be used for getting and setting the texture coordinates.
Parameters:
|
U32 index |
Index of the specific normal |
|
U32 LayerNum=0 |
Defaults to layer 0 if no layer is specified |
Return Values:
IFXVector2*
This method returns the number of user-defined vertex attributes in the mesh.
Return Values:
IFXAuthorGeomIndex
This method sets the current number of user-defined vertex attributes in the mesh and returns the number once set.
Parameters:
|
U32 numAttribs |
Current number of attributes |
Return Values:
IFXAuthorGeomIndex
This method returns a pointer to an IFXGenericAttribute in the mesh that stores an attribute. GetGenericVertexAttribute() must be called for each attribute to be accessed. This method can be used for getting and setting the vertex attributes.
Parameters:
|
U32 index |
Index of the specific attribute |
Return Values:
IFXGenericAttribute*
This method returns the number of user-defined face attributes in the mesh.
Return Values:
IFXAuthorGeomIndex
This method sets the current number of user-defined face attributes in the mesh and returns the number once set.
Parameters:
|
U32 numAttribs |
Current number of attributes |
Return Values:
IFXAuthorGeomIndex
This method returns a pointer to an IFXGenericAttribute in the mesh that stores an attribute. GetGenericFaceAttribute() must be called for each attribute to be accessed. This method can be used for getting and setting the face attributes.
Parameters:
|
U32 index |
Index of the specific attribute |
Return Values:
IFXGenericFaceAttribute*
This method returns a pointer to the IFXUVMap which stores the vertex map. GetUVMap() must be called.
Parameters:
|
U32 layerNum |
The layer number |
Return Values:
IFXUVMap*
This method sets the IFXUVMap to point to a specific Vertex Map.
Parameters:
|
U32 index |
Index of the specific vertex map |
|
IFXUVMap *pUVMap |
Pointer to the IFX Vertex Map |
Return Values:
IFXUVMap*
This method sets the base vertex.
Parameters:
|
U32 index |
Index of the specific base vertex |
|
in_base |
The base vertex provided it exists in the mesh |
This method gets the base vertex.
Parameters:
|
U32 index |
Index of the specific base vertex |
Return Values:
BOOL
This method returns the number of base vertices.
Parameters:
None
Return Values:
Integer
This method sets the vertex weight count.
Parameters:
|
in_PositionIndex |
Index of the specific vertex weight |
|
in_Cnt |
The vertex weight count |
This method sets the vertex weight.
Parameters:
|
in_PositionIndex |
Index of the specific vertex weight |
|
in_WghtIdx |
Weight index number |
|
in_BoneID |
Bone ID number |
|
in_Weight |
Vertex weight amount |
This method returns the vertex weight count.
Parameters:
|
in_PositionIndex |
Index of the specific vertex weight |
Return Values:
Integer
This method returns the vertex weight.
Parameters:
|
in_PositionIndex |
Index of the specific vertex weight |
|
in_ArraySize |
Array size |
|
out_BoneIDs |
Bone ID number |
|
out_Weights |
Vertex weight amount |
This method returns the name of the mesh.
Parameters:
None
Return Values:
CIFXString
This method sets the name of the mesh.
Parameters:
|
pMeshName |
Pointer to the name string of the mesh |
Return Values:
None
This method returns the parent name of the mesh.
Parameters:
None
Return Values:
CIFXString
This method sets the parent name of the mesh.
Parameters:
|
pMeshName |
Pointer to the name string of the mesh |
Return Values:
None
§See asterisked (*) statement at Legal Information © 2001 Intel Corporation.