iPolygonMesh Struct ReferenceThis interface reprents a mesh of polygons.
Inheritance diagram for iPolygonMesh:
Public Member Functions
|virtual uint32||GetChangeNumber () const =0|
|When this number changes you know the polygon mesh has changed (deformation has occured) since the last time you got another number from this function. |
|virtual csFlags &||GetFlags ()=0|
|Get flags for this polygon mesh. |
|virtual int||GetPolygonCount ()=0|
|Get the number of polygons for this mesh. |
|virtual csMeshedPolygon *||GetPolygons ()=0|
|Get the pointer to the array of polygons. |
|virtual int||GetTriangleCount ()=0|
|Get the number of triangles for this mesh. |
|virtual csTriangle *||GetTriangles ()=0|
|Get the triangle table for this mesh. |
|virtual int||GetVertexCount ()=0|
|Get the number of vertices for this mesh. |
|virtual csVector3 *||GetVertices ()=0|
|Get the pointer to the array of vertices. |
|virtual void||Lock ()=0|
|Lock the polygon mesh. |
|virtual void||Unlock ()=0|
|Unlock the polygon mesh. |
Detailed DescriptionThis interface reprents a mesh of polygons.
It is useful to communicate geometry information outside of the engine. One place where this will be useful is for communicating geometry information to the collision detection plugin.
All Crystal Space mesh objects (things, sprites, ...) should implement and/or embed an implementation of this interface.
A polygon mesh has the concept of a vertex buffer and an array of polygons. A triangle mesh is also supported. A mesh object typically only implements either a polygon mesh or a triangle mesh. In that case requesting the other type of mesh will automatically generate the new format. iPolygonMesh can use csPolygonMeshTools::Triangulate() and csPolygonMeshTools::Polygonize() to help with that.
Main creators of instances implementing this interface:
- Almost all mesh objects have several implementations of this interface.
Main ways to get pointers to this interface:
Main users of this interface:
- Collision detection plugins (iCollideSystem)
- Visibility culler plugins (iVisibilityCuller)
- Shadow stencil plugin
Member Function Documentation
|virtual uint32 iPolygonMesh::GetChangeNumber||(||)|| const
|virtual csFlags& iPolygonMesh::GetFlags||(||)||
Get flags for this polygon mesh.
This is zero or a combination of the following flags:
- CS_POLYMESH_CLOSED: mesh is closed.
- CS_POLYMESH_NOTCLOSED: mesh is not closed.
- CS_POLYMESH_CONVEX: mesh is convex.
- CS_POLYMESH_NOTCONVEX: mesh is not convex.
- CS_POLYMESH_DEFORMABLE: mesh is deformable.
- CS_POLYMESH_TRIANGLEMESH: mesh prefers triangle mesh.
Note that if neither CS_POLYMESH_CLOSED nor CS_POLYMESH_NOTCLOSED are set then the closed state is not known. Setting both is illegal. Note that if neither CS_POLYMESH_CONVEX nor CS_POLYMESH_NOTCONVEX are set then the convex state is not known. Setting both is illegal.
|virtual int iPolygonMesh::GetPolygonCount||(||)||
|virtual csMeshedPolygon* iPolygonMesh::GetPolygons||(||)||
|virtual int iPolygonMesh::GetTriangleCount||(||)||
|virtual csTriangle* iPolygonMesh::GetTriangles||(||)||
|virtual int iPolygonMesh::GetVertexCount||(||)||
|virtual csVector3* iPolygonMesh::GetVertices||(||)||
|virtual void iPolygonMesh::Lock||(||)||
|virtual void iPolygonMesh::Unlock||(||)||
The documentation for this struct was generated from the following file:
Generated for Crystal Space 1.0.2 by doxygen 1.4.7