Main Page Modules Class Hierarchy Alphabetical List Compound List Compound Members
CSLPolygonList Class Reference
Describes a list of n-sided polygons.
More...
#include <PolygonList.h>
Inheritance diagram for CSLPolygonList::
List of all members.Public Types
Public Methods
Detailed Description
Describes a list of n-sided polygons.
The CSLPolygonList class describes a list of polygons that are made up of N number of vertices. The polygons in this list can have normals, UV and color information as well.
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 polygons in the list, use GetPolygonCount(). To find out how many vertices a particular polygon uses, first get the list of polygon vertex count use GetPolygonVertexCountList().
Member Typedef Documentation
typedef CSLArrayProxy<SI_Int, SI_Int, 1> CSLPolygonList::CSLIntArray
|
|
|
Proxy class that allows modifying a list of SI_Int like an array. |
Constructor & Destructor Documentation
|
Constructor -
Parameters:
-
in_pScene |
Pointer to the scene containing the polygon list |
in_pModel |
Pointer to the model containing the polygon list |
in_pTemplate |
Pointer to the CdotXSITemplate containing the polygon list |
-
Returns:
-
an instance of CSLPolygonList
|
CSLPolygonList::~CSLPolygonList |
( |
|
) |
[virtual] |
|
Member Function Documentation
CSLArrayProxy< SI_Int, SI_Int, 1 > * CSLPolygonList::AddUVArray |
( |
|
) |
|
|
|
Create a new UV indices array. -
Returns:
-
CSLIntArray* Pointer to the newly created array.
|
SI_Error CSLPolygonList::ClearUVArrays |
( |
|
) |
|
|
|
Remove all UV indices array. -
Returns:
-
SI_Error Error code.
|
CSLArrayProxy< SI_Int, SI_Int, 1 > * CSLPolygonList::CreateColorIndices |
( |
|
) |
|
|
|
Create a color indices array. -
Returns:
-
CSLIntArray* Pointer to the newly created array.
|
CSLArrayProxy< SI_Int, SI_Int, 1 > * CSLPolygonList::CreateNormalIndices |
( |
|
) |
|
|
|
Create a normal indices array. -
Returns:
-
CSLIntArray* Pointer to the newly created array.
|
SI_Error CSLPolygonList::DestroyColorIndices |
( |
|
) |
|
|
|
Destroy the color indices array. -
Returns:
-
SI_Error Error code.
|
SI_Error CSLPolygonList::DestroyNormalIndices |
( |
|
) |
|
|
|
Destroy the normal indices array. -
Returns:
-
SI_Error Error code.
|
CSLIntArray* CSLPolygonList::GetColorIndices |
( |
|
) |
[inline] |
|
|
Return the color indices array proxy. -
Returns:
-
CSLIntArray* Pointer to an array proxy of color indices.
|
SI_Int * CSLPolygonList::GetColorIndicesPtr |
( |
|
) |
|
|
|
Returns an array of SI_Int containing the color index list. -
Returns:
-
SI_Int* Array of SI_Int
|
|
Return the material object of the polygon list. -
Returns:
-
CSLBaseMaterial* Texture projection name.
|
CSLIntArray* CSLPolygonList::GetNormalIndices |
( |
|
) |
[inline] |
|
|
Return the normal indices array proxy. -
Returns:
-
CSLIntArray* Pointer to an array proxy of normal indices.
|
SI_Int * CSLPolygonList::GetNormalIndicesPtr |
( |
|
) |
|
|
|
Returns an array of SI_Int containing the normal index list. -
Returns:
-
SI_Int* Array of SI_Int
|
SI_Int CSLPolygonList::GetPolygonCount |
( |
|
) |
[inline] |
|
|
Returns the number of polygons in this list. -
Returns:
-
SI_Int Number of polygons
|
CSLIntArray* CSLPolygonList::GetPolygonVertexCountList |
( |
|
) |
[inline] |
|
|
Return the polygon vertex count array proxy. -
Returns:
-
CSLIntArray* Pointer to an array proxy of polygon vertex count.
|
SI_Int* CSLPolygonList::GetPolygonVertexCountListPtr |
( |
|
) |
[inline] |
|
|
Returns an array of SI_Int containing the number of vertices for each polygon. -
Returns:
-
SI_Int* Array of SI_Int
|
SI_Int CSLPolygonList::GetUVArrayCount |
( |
|
) |
|
|
|
Return the number of texture coordinate arrays. -
Returns:
-
SI_Int Number of UV arrays.
|
CSLArrayProxy< SI_Int, SI_Int, 1 > * CSLPolygonList::GetUVIndices |
( |
SI_Int |
in_nId |
) |
|
|
|
Return the UV indices array proxy. -
Parameters:
-
in_nId |
Identification of the UV array to retrieve. |
-
Returns:
-
CSLIntArray* Pointer to an array proxy of UV indices.
|
SI_Int * CSLPolygonList::GetUVIndicesPtr |
( |
SI_Int |
in_nId |
) |
|
|
|
Returns an array of SI_Int containing the UV index list. -
Parameters:
-
in_nId |
Identification of the UV array to retrieve. |
-
Returns:
-
SI_Int* Array of SI_Int
|
SI_Int CSLPolygonList::GetVertexCount |
( |
|
) |
[inline] |
|
|
Returns the number of vertices referred by all polygons in this list. -
Returns:
-
SI_Int Number of vertices
|
CSLIntArray* CSLPolygonList::GetVertexIndices |
( |
|
) |
[inline] |
|
|
Return the vertex indices array proxy. -
Returns:
-
CSLIntArray* Pointer to an array proxy of vertex indices.
|
SI_Int* CSLPolygonList::GetVertexIndicesPtr |
( |
|
) |
[inline] |
|
|
Returns an array of SI_Int containing the vertex index list. -
Returns:
-
SI_Int* Array of SI_Int
|
CSLAnimatableType * CSLPolygonList::ParameterFromName |
( |
SI_Char * |
in_szName |
) |
[virtual] |
|
|
Gets a handle on one of this polygon list's parameters by using its name -
Parameters:
-
in_szName |
the name of the parameter to get the handle from |
-
Returns:
-
CSLAnimatableType* the handle to the parameter
Reimplemented from CSLTemplate. |
SI_Error CSLPolygonList::RemoveUVArray |
( |
|
) |
|
|
|
Remove the last UV indices array. -
Returns:
-
SI_Error Error code.
|
SI_Void CSLPolygonList::SetMaterial |
( |
CSLBaseMaterial * |
in_pNewMaterial |
) |
[inline] |
|
|
Change the material object of the polygon list. -
Parameters:
-
in_pNewMaterial |
New material object. |
-
Returns:
-
SI_Void
|
SI_Error CSLPolygonList::Synchronize |
( |
|
) |
[virtual] |
|
|
Updates the template with information from this polygon list -
Returns:
-
SI_Error Whether or not the template could be updated
Reimplemented from CSLTemplate. |
|
Returns the type of this template -
Returns:
-
ETemplateType
Reimplemented from CSLTemplate. |
The documentation for this class was generated from the following files:
- PolygonList.h
- PolygonList.cpp
© Copyright 2001-2003 Avid Technology, Inc. All rights reserved.
© Copyright 2001-2003 Avid Technology, Inc. All rights reserved.