# CSLMesh Class Reference

`#include <Mesh.h>`

Inheritance diagram for CSLMesh:

List of all members.

## Public Member Functions
SI_Error | ClearPolygonLists ()
SI_Error | ClearTriangleLists ()
SI_Error | ClearTriangleStripLists ()
SI_Int | GetPolygonListCount ()
SI_Int | GetTriangleListCount ()
SI_Int | GetTriangleStripListCount ()
CSLPolygonList ** | PolygonLists ()
CSLTriangleList ** | TriangleLists ()
CSLTriangleStripList ** | TriangleStripLists ()
CSLPolygonList * | AddPolygonList ()
CSLTriangleList * | AddTriangleList ()
CSLTriangleStripList * | AddTriangleStripList ()
SI_Error | RemovePolygonList (SI_Int l_nIndex)
SI_Error | RemoveTriangleList (SI_Int l_nIndex)
SI_Error | RemoveTriangleStripList (SI_Int l_nIndex)
SI_Error | RemovePolygonList (CSLPolygonList *in_pObject)
SI_Error | RemoveTriangleList (CSLTriangleList *in_pObject)
SI_Error | RemoveTriangleStripList (CSLTriangleStripList *in_pObject)
CSLBaseShape * | Shape ()
virtual SI_Error | Synchronize ()
virtual SI_Error | Fix ()
virtual ETemplateType | Type ()
virtual CSLAnimatableType * | ParameterFromName (SI_Char *in_szName)

## Detailed Description

Describes a mesh primitive (see the SI_Mesh template reference).

The CSLMesh class is used to manipulate the polygon, tiangle or tri-strip lists.

## Member Function Documentation

SI_Error ClearPolygonLists | ( |  | ) |

Clears the entire list of polygon lists

Returns:
  SI_Error Error code

SI_Error ClearTriangleLists | ( |  | ) |

Clears the entire list of triangle lists

Returns:
  SI_Error Error code

SI_Error ClearTriangleStripLists | ( |  | ) |

Clears the entire list of triangle strip lists

Returns:
  SI_Error Error code

SI_Int GetPolygonListCount | ( |  | ) |

Returns the number of polygon lists for this mesh

Returns:
  SI_Int Number of polygon lists

SI_Int GetTriangleListCount | ( |  | ) |

Returns the number of triangle lists for this mesh

Returns:
  SI_Int Number of triangle lists

SI_Int GetTriangleStripListCount | ( |  | ) |

Returns the number of triangle strip lists for this mesh

Returns:
  SI_Int Number of triangle strip lists

CSLPolygonList** PolygonLists | ( |  | ) |

Returns the list of polygon lists used by this mesh

Returns:
  CSLPolygonList** A list of CSLPolygonList SI_Int GetTriangleListCount(); SI_Int GetTriangleStripListCount();

CSLTriangleList** TriangleLists | ( |  | ) |

Returns the list of triangle lists used by this mesh

Returns:
  CSLTriangleList** A list of CSLTriangleList

CSLTriangleStripList** TriangleStripLists | ( |  | ) |

Returns the list of triangle strip lists used by this mesh

Returns:
  CSLTriangleStripList** A list of CSLTriangleStripList

CSLPolygonList* AddPolygonList | ( |  | ) |

Add a new polygon list to the mesh.

Returns:
  CSLPolygonList* Pointer to the newly created polygon list object.

CSLTriangleList* AddTriangleList | ( |  | ) |

Add a new triangle list to the mesh.

Returns:
  CSLTriangleList* Pointer to the newly created triangle list object.

CSLTriangleStripList* AddTriangleStripList | ( |  | ) |

Add a new triangle strip list to the mesh.

Returns:
  CSLTriangleStripList* Pointer to the newly created triangle strip list object.

SI_Error RemovePolygonList | ( | SI_Int | l_nIndex | ) |

Remove a single polygon list from the mesh.

Parameters:

  | SI_Int | Index of the polygon list to remove.

Returns:
  SI_Error Error code.

SI_Error RemoveTriangleList | ( | SI_Int | l_nIndex | ) |

Remove a single triangle list from the mesh.

Parameters:

  | SI_Int | Index of the triangle list to remove.

Returns:
  SI_Error Error code.

SI_Error RemoveTriangleStripList | ( | SI_Int | l_nIndex | ) |

Remove a single triangle strip list from the mesh.

Parameters:

  | SI_Int | Index of the triangle strip list to remove.

Returns:
  SI_Error Error code.

SI_Error RemovePolygonList | ( | CSLPolygonList * | in_pObject | ) |

Remove a single polygon list from the mesh.

Parameters:

  | CSLPolygonList* | Pointer to the polygon list to remove.

Returns:
  SI_Error Error code.

SI_Error RemoveTriangleList | ( | CSLTriangleList * | in_pObject | ) |

Remove a single triangle list from the mesh.

Parameters:

  | CSLTriangleList* | Pointer to the triangle list to remove.

Returns:
  SI_Error Error code.

SI_Error RemoveTriangleStripList | ( | CSLTriangleStripList * | in_pObject | ) |

Remove a single triangle strip list from the mesh.

Parameters:

  | CSLTriangleStripList* | Pointer to the triangle strip list to remove.

Returns:
  SI_Error Error code.

CSLBaseShape* Shape | ( |  | ) | `[inline]`

Return the shape object of the mesh.

Returns:
  CSLBaseShape* Pointer to a shape object.

virtual SI_Error Synchronize | ( |  | ) | `[virtual]`

Synchronizes this geometry instance with its IO layer representation

Returns:
  SI_Error

Return values:

  | SI_SUCCESS | this function always returns SI_SUCCESS

Reimplemented from CSLGeometry.

virtual SI_Error Fix | ( |  | ) | `[virtual]`

Clean invalid data from the template.

Returns:
  SI_Error Error code

Reimplemented from CSLTemplate.

virtual ETemplateType Type | ( |  | ) | `[inline, virtual]`

Indicate which dotXSI template this object describes.

Returns:
  ETemplateType Type of template

Implements CSLTemplate.

virtual CSLAnimatableType* ParameterFromName | ( | SI_Char * | in_szName | ) | `[virtual]`

Gets a handle on one of this geometry'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 CSLGeometry.

The documentation for this class was generated from the following file:

- Mesh.h