CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

iClothFactoryState Struct Reference

This interface describes the API for the cloth mesh factory. More...

#include <clothmesh.h>

Inheritance diagram for iClothFactoryState:

iBase List of all members.

Public Methods

virtual void SetMaterialWrapper (iMaterialWrapper *material)=0
 Set material of factory. More...

virtual iMaterialWrapperGetMaterialWrapper () const=0
 Get material of factory. More...

virtual void SetVertexCount (int n)=0
 Set the number of vertices to use for this mesh. More...

virtual int GetVertexCount () const=0
 Get the number of vertices for this mesh. More...

virtual csVector3GetVertices ()=0
 Get the array of vertices. More...

virtual csVector2GetTexels ()=0
 Get the array of texels. More...

virtual csVector3GetNormals ()=0
 Get the array of normals. More...

virtual void SetTriangleCount (int n)=0
 Set the number of triangles to use for this mesh. More...

virtual int GetTriangleCount () const=0
 Get the number of triangles for this mesh. More...

virtual csTriangleGetTriangles ()=0
 Get the array of triangles. More...

virtual csColorGetColors ()=0
 Get the array of colors. More...

virtual void Invalidate ()=0
 After making a significant change to the vertices or triangles you probably want to let this object recalculate the bounding boxes and such. More...

virtual void CalculateNormals ()=0
 Automatically calculate normals based on the current mesh. More...

virtual void GenerateFabric (uint Xsize, uint Ysize)=0
 Automatically generate a squared cloth. More...


Detailed Description

This interface describes the API for the cloth mesh factory.

Definition at line 72 of file clothmesh.h.


Member Function Documentation

virtual void iClothFactoryState::CalculateNormals   [pure virtual]
 

Automatically calculate normals based on the current mesh.

virtual void iClothFactoryState::GenerateFabric uint    Xsize,
uint    Ysize
[pure virtual]
 

Automatically generate a squared cloth.

virtual csColor* iClothFactoryState::GetColors   [pure virtual]
 

Get the array of colors.

It is legal to modify the colors in this array. The number of colors in this array will be equal to the number of vertices set. Note that modifying the colors will not do a lot if manual colors is not enabled (SetManualColors).

virtual iMaterialWrapper* iClothFactoryState::GetMaterialWrapper   const [pure virtual]
 

Get material of factory.

virtual csVector3* iClothFactoryState::GetNormals   [pure virtual]
 

Get the array of normals.

It is legal to modify the normals in this array. The number of normals in this array will be equal to the number of vertices set. Note that modifying the normals is only useful when manual colors are not enabled and lighting is enabled because the normals are used for lighting.

virtual csVector2* iClothFactoryState::GetTexels   [pure virtual]
 

Get the array of texels.

It is legal to modify the texels in this array. The number of texels in this array will be equal to the number of vertices set.

virtual int iClothFactoryState::GetTriangleCount   const [pure virtual]
 

Get the number of triangles for this mesh.

virtual csTriangle* iClothFactoryState::GetTriangles   [pure virtual]
 

Get the array of triangles.

It is legal to modify the triangles in this array. The number of triangles in this array will be equal to the number of triangles set.

virtual int iClothFactoryState::GetVertexCount   const [pure virtual]
 

Get the number of vertices for this mesh.

virtual csVector3* iClothFactoryState::GetVertices   [pure virtual]
 

Get the array of vertices.

It is legal to modify the vertices in this array. The number of vertices in this array will be equal to the number of vertices set.

virtual void iClothFactoryState::Invalidate   [pure virtual]
 

After making a significant change to the vertices or triangles you probably want to let this object recalculate the bounding boxes and such.

This function will invalidate the internal data structures so that they are recomputed.

virtual void iClothFactoryState::SetMaterialWrapper iMaterialWrapper   material [pure virtual]
 

Set material of factory.

virtual void iClothFactoryState::SetTriangleCount int    n [pure virtual]
 

Set the number of triangles to use for this mesh.

virtual void iClothFactoryState::SetVertexCount int    n [pure virtual]
 

Set the number of vertices to use for this mesh.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.14