CrystalSpace

Public API Reference

CS::Utility::MeshFilter Class Reference

Structure holding filtering data in order to restrict the list of meshes from a scene that must be rendered. More...

#include <cstool/meshfilter.h>

List of all members.

Public Member Functions

void AddFilterMesh (iMeshWrapper *mesh, bool addChildren=false)
 Add a mesh to this filter.
void Clear ()
 Clear all meshes in this list.
MeshFilterMode GetFilterMode () const
 Get the filtering mode for this filter.
bool IsMeshFiltered (iMeshWrapper *mesh) const
 Return wheter or not this mesh should be rendered.
void RemoveFilterMesh (iMeshWrapper *mesh)
 Remove a mesh from this filter.
void SetFilterMode (MeshFilterMode mode)
 Set the filtering mode for this filter.

Detailed Description

Structure holding filtering data in order to restrict the list of meshes from a scene that must be rendered.

This is basically a list of iMeshWrapper's that can be either included or excluded from rendering (depending on the selected MeshFilterMode).

Main ways to get pointers to this interface:

Definition at line 55 of file meshfilter.h.


Member Function Documentation

void CS::Utility::MeshFilter::AddFilterMesh ( iMeshWrapper mesh,
bool  addChildren = false 
)

Add a mesh to this filter.

Parameters:
mesh The mesh to be added
addChildren Whether or not the children of this mesh must be considered too.
void CS::Utility::MeshFilter::Clear (  ) 

Clear all meshes in this list.

MeshFilterMode CS::Utility::MeshFilter::GetFilterMode (  )  const [inline]

Get the filtering mode for this filter.

Definition at line 88 of file meshfilter.h.

bool CS::Utility::MeshFilter::IsMeshFiltered ( iMeshWrapper mesh  )  const

Return wheter or not this mesh should be rendered.

Returns:
true if the mesh should be excluded, false otherwise.
void CS::Utility::MeshFilter::RemoveFilterMesh ( iMeshWrapper mesh  ) 

Remove a mesh from this filter.

void CS::Utility::MeshFilter::SetFilterMode ( MeshFilterMode  mode  )  [inline]

Set the filtering mode for this filter.

The default value is CS::Utility::MESH_FILTER_EXCLUDE.

Definition at line 82 of file meshfilter.h.


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

Generated for Crystal Space 2.1 by doxygen 1.6.1