Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLTriangleList Class Reference

#include <TriangleList.h>

Inheritance diagram for CSLTriangleList::

CSLTemplate CSIBCNode List of all members.

Public Types

Public Methods


Detailed Description

CSLTriangleList Class

The CSLTriangleList class describes a list of triangles.

It may also contain information about normals, UV coordinates and color. To find out, you may use the GetNormalIndices(), GetUVIndices() and GetColorIndices() and check if the return value is non-NULL.

To get the number of triangles in the list, use GetTriangleCount().

See also:
CSLPolygonList , CSLTriStripList


Member Typedef Documentation

typedef CSLArrayProxy<SLTriangle, SI_Int, 3> CSLTriangleList::CSLTriangleArray
 

Proxy class that allows modifying a list of SLTriangle structures like an array.


Member Function Documentation

CSLTriangleList::CSLTriangleArray * CSLTriangleList::AddUVArray  
 

Create a new UV indices array.

Returns:
CSLTriangleArray* Pointer to the newly created array.

SI_Error CSLTriangleList::ClearUVArrays  
 

Remove all UV indices array.

Returns:
SI_Error Error code.

CSLTriangleList::CSLTriangleArray * CSLTriangleList::CreateColorIndices  
 

Create a color indices array.

Returns:
CSLTriangleArray* Pointer to the newly created array.

CSLTriangleList::CSLTriangleArray * CSLTriangleList::CreateNormalIndices  
 

Create a normal indices array.

Returns:
CSLTriangleArray* Pointer to the newly created array.

SI_Error CSLTriangleList::DestroyColorIndices  
 

Destroy the color indices array.

Returns:
SI_Error Error code.

SI_Error CSLTriangleList::DestroyNormalIndices  
 

Destroy the normal indices array.

Returns:
SI_Error Error code.

CSLTriangleArray* CSLTriangleList::GetColorIndices   [inline]
 

Return the color indices array proxy.

Returns:
CSLTriangleArray* Pointer to an array proxy of color indices.

SI_Int * CSLTriangleList::GetColorIndicesPtr  
 

Returns an array of SI_Int containing the color index list.

Returns:
SI_Int* Array of SI_Int

CSLBaseMaterial* CSLTriangleList::GetMaterial   [inline]
 

Return the material object of the triangle list.

Returns:
CSLBaseMaterial* Texture projection name.

CSLTriangleArray* CSLTriangleList::GetNormalIndices   [inline]
 

Return the normal indices array proxy.

Returns:
CSLTriangleArray* Pointer to an array proxy of normal indices.

SI_Int * CSLTriangleList::GetNormalIndicesPtr  
 

Returns an array of SI_Int containing the normal index list.

Returns:
SI_Int* Array of SI_Int

SI_Int CSLTriangleList::GetTriangleCount   [inline]
 

Returns the number of triangles in this list.

Returns:
SI_Int Number of triangles

SI_Int CSLTriangleList::GetUVArrayCount  
 

Return the number of texture coordinate arrays.

Returns:
SI_Int Number of UV arrays.

CSLTriangleList::CSLTriangleArray * CSLTriangleList::GetUVIndices SI_Int    in_nId
 

Return the UV indices array proxy.

Parameters:
SI_Int  Identification of the UV array to retrieve.
Returns:
CSLTriangleArray* Pointer to an array proxy of UV indices.

SI_Int * CSLTriangleList::GetUVIndicesPtr SI_Int    in_nId
 

Returns an array of SI_Int containing the UV index list.

Returns:
SI_Int* Array of SI_Int

CSLTriangleArray* CSLTriangleList::GetVertexIndices   [inline]
 

Return the vertex indices array proxy.

Returns:
CSLTriangleArray* Pointer to an array proxy of vertex indices.

SI_Int* CSLTriangleList::GetVertexIndicesPtr   [inline]
 

Returns an array of SI_Int containing the vertex index list.

Returns:
SI_Int* Array of SI_Int

CSLAnimatableType * CSLTriangleList::ParameterFromName SI_Char *    in_szName [virtual]
 

Return a proxy to the specified parameter.

Parameters:
in_szName  Name of the parameter
Returns:
CSLAnimatableType* Pointer to a parameter proxy.

Reimplemented from CSLTemplate.

SI_Error CSLTriangleList::RemoveUVArray  
 

Remove the last UV indices array.

Returns:
SI_Error Error code.

SI_Void CSLTriangleList::SetMaterial CSLBaseMaterial   in_pNewMaterial [inline]
 

Change the material object of the triangle list.

Parameters:
CSLBaseMaterial  * New material object.
Returns:
None

SI_Error CSLTriangleList::Synchronize   [virtual]
 

Synchronize will ensure that the animated parameter is up to date.

Returns:
SI_Error Error code

Reimplemented from CSLTemplate.

virtual ETemplateType CSLTriangleList::Type   [inline, virtual]
 

Indicate which dotXSI template this object describes.

Returns:
ETemplateType Type of template

Reimplemented from CSLTemplate.


The documentation for this class was generated from the following files: © Copyright 2001-2003 Avid Technology, Inc. All rights reserved.

© Copyright 2001-2003 Avid Technology, Inc. All rights reserved.