CrystalSpace

Public API Reference

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

iLODControl Struct Reference
[Mesh support]

The iLODControl interface represents an object that has controllable LOD features. More...

#include <lod.h>

Inheritance diagram for iLODControl:

iBase List of all members.

Public Methods

virtual uint32 GetLODFeatures () const=0
 Get a mask with the currently enabled features for this mesh object. More...

virtual void SetLODFeatures (uint32 mask, uint32 value)=0
 Set the features you want this mesh object to support. More...

virtual void SetLOD (float lod)=0
 Set the LOD level of this mesh object (for polygon count). More...

virtual float GetLOD () const=0
 Get the current LOD settng for this mesh object (between 0 and 1). More...

virtual int GetLODPolygonCount (float lod) const=0
 Get a rough estimate of the number of polygons for a given LOD value (between 0 and 1, similar to the value used by SetLOD()). More...

virtual uint32 GetAvailableLODFeatures () const=0
 Get a mask with the available LOD features for this mesh object. More...

virtual uint32 GetAvailableDistanceFeatures () const=0
 Get a mask with the available LOD distance reduction features for this mesh object. More...

virtual uint32 GetDistanceReduction () const=0
 Get a mask with the currently enabled distance reduction features for this mesh object. More...

virtual void SetDistanceReduction (uint32 mask, uint32 value)=0
 Set the features you want supported in distance reduction. More...

virtual void SetLODPriority (uint16 group)=0
 Set the priority level for this object can be from 0 to 255 0 being the highest priority, 255 being the lowest. More...

virtual uint16 GetLODPriority () const=0
 Get the features priority level for this object. More...


Detailed Description

The iLODControl interface represents an object that has controllable LOD features.

In the future the LOD manager will be able to work with this.

Definition at line 60 of file lod.h.


Member Function Documentation

virtual uint32 iLODControl::GetAvailableDistanceFeatures   const [pure virtual]
 

Get a mask with the available LOD distance reduction features for this mesh object.

The values in this mask are combinations of the CS_LOD_* flags.

virtual uint32 iLODControl::GetAvailableLODFeatures   const [pure virtual]
 

Get a mask with the available LOD features for this mesh object.

The values in this mask are combinations of the CS_LOD_* flags.

virtual uint32 iLODControl::GetDistanceReduction   const [pure virtual]
 

Get a mask with the currently enabled distance reduction features for this mesh object.

Some features may be disabled by the engine. The values in this mask are combinations of the CS_LOD_* flags.

virtual float iLODControl::GetLOD   const [pure virtual]
 

Get the current LOD settng for this mesh object (between 0 and 1).

virtual uint32 iLODControl::GetLODFeatures   const [pure virtual]
 

Get a mask with the currently enabled features for this mesh object.

For LOD purposes some features may be disabled by the engine. The values in this mask are combinations of the CS_LOD_* flags.

virtual int iLODControl::GetLODPolygonCount float    lod const [pure virtual]
 

Get a rough estimate of the number of polygons for a given LOD value (between 0 and 1, similar to the value used by SetLOD()).

Note that a mesh object that doesn't support LOD should always return the same number of polygons.

virtual uint16 iLODControl::GetLODPriority   const [pure virtual]
 

Get the features priority level for this object.

virtual void iLODControl::SetDistanceReduction uint32    mask,
uint32    value
[pure virtual]
 

Set the features you want supported in distance reduction.

The values in this mask are combinations of the CS_LOD_* flags.

virtual void iLODControl::SetLOD float    lod [pure virtual]
 

Set the LOD level of this mesh object (for polygon count).

A value of 1 (default) means that the mesh object will use full detail. A value of 0 means that the mesh object will use lowest possible detail while still being useful (i.e. a value of 0 should not result in no triangles to render).

virtual void iLODControl::SetLODFeatures uint32    mask,
uint32    value
[pure virtual]
 

Set the features you want this mesh object to support.

Features can be disabled by the engine for LOD purposes. The values in this mask are combinations of the CS_LOD_* flags. The following values are possible in the mask (CS_LOD_ALL represents all):

  • CS_LOD_TRIANGLE_REDUCTION
  • CS_LOD_LIGHT_QUALITY
  • CS_LOD_LIGHT_QUANTITY
  • CS_LOD_FRAME_ANIMATION
  • CS_LOD_SKELETAL_ANIMATION
  • CS_LOD_TEXTURE_DETAIL
  • CS_LOD_TEXTURE_SIZE
  • CS_LOD_DISTANCE_REDUCTION

virtual void iLODControl::SetLODPriority uint16    group [pure virtual]
 

Set the priority level for this object can be from 0 to 255 0 being the highest priority, 255 being the lowest.

It is 0 by default


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