OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::LodStrategy Class Referenceabstract

Strategy for determining level of detail. More...

#include <OgreLodStrategy.h>

+ Inheritance diagram for Ogre::LodStrategy:
+ Collaboration diagram for Ogre::LodStrategy:

Public Member Functions

 LodStrategy (const String &name)
 Constructor accepting name. More...
 
virtual ~LodStrategy ()
 Virtual destructor. More...
 
virtual Real getBaseValue () const =0
 Get the value of the first (highest) level of detail. More...
 
const StringgetName () const
 Get the name of this strategy. More...
 
Real getValue (const MovableObject *movableObject, const Camera *camera) const
 Compute the LOD value for a given movable object relative to a given camera. More...
 
virtual void lodUpdateImpl (const size_t numNodes, ObjectData t, const Camera *camera, Real bias) const =0
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
virtual Real transformBias (Real factor) const =0
 Transform LOD bias so it only needs to be multiplied by the LOD value. More...
 
virtual Real transformUserValue (Real userValue) const
 Transform user supplied value to internal value. More...
 

Static Public Member Functions

static void assertSorted (const Mesh::LodValueArray &values)
 Assert that the LOD values are sorted from greatest detail to least detail. More...
 
static ushort getIndex (Real value, const Mesh::MeshLodUsageList &meshLodUsageList)
 Get the index of the LOD usage which applies to a given value. More...
 
static ushort getIndex (Real value, const Material::LodValueArray &materialLodValueArray)
 Get the index of the LOD usage which applies to a given value. More...
 
static bool isSorted (const Mesh::LodValueArray &values)
 Determine if the LOD values are sorted from greatest detail to least detail. More...
 
static void lodSet (ObjectData &t, Real lodValues[ARRAY_PACKED_REALS])
 
static void sort (Mesh::MeshLodUsageList &meshLodUsageList)
 Sort mesh LOD usage list from greatest to least detail. More...
 

Protected Member Functions

virtual Real getValueImpl (const MovableObject *movableObject, const Camera *camera) const =0
 Compute the LOD value for a given movable object relative to a given camera. More...
 

Protected Attributes

String mName
 Name of this strategy. More...
 

Detailed Description

Strategy for determining level of detail.

Remarks
Generally, to create a new LOD strategy, all of the following will need to be implemented: getValueImpl, getBaseValue, transformBias, getIndex, sort, and isSorted. In addition, transformUserValue may be overridden.

Definition at line 53 of file OgreLodStrategy.h.

Constructor & Destructor Documentation

Ogre::LodStrategy::LodStrategy ( const String name)

Constructor accepting name.

virtual Ogre::LodStrategy::~LodStrategy ( )
virtual

Virtual destructor.

Member Function Documentation

static void Ogre::LodStrategy::assertSorted ( const Mesh::LodValueArray values)
static

Assert that the LOD values are sorted from greatest detail to least detail.

virtual Real Ogre::LodStrategy::getBaseValue ( ) const
pure virtual

Get the value of the first (highest) level of detail.

Implemented in Ogre::DistanceLodStrategyBase, and Ogre::PixelCountLodStrategyBase.

static ushort Ogre::LodStrategy::getIndex ( Real  value,
const Mesh::MeshLodUsageList meshLodUsageList 
)
static

Get the index of the LOD usage which applies to a given value.

static ushort Ogre::LodStrategy::getIndex ( Real  value,
const Material::LodValueArray materialLodValueArray 
)
static

Get the index of the LOD usage which applies to a given value.

const String& Ogre::LodStrategy::getName ( void  ) const
inline

Get the name of this strategy.

Definition at line 109 of file OgreLodStrategy.h.

Real Ogre::LodStrategy::getValue ( const MovableObject movableObject,
const Camera camera 
) const

Compute the LOD value for a given movable object relative to a given camera.

virtual Real Ogre::LodStrategy::getValueImpl ( const MovableObject movableObject,
const Camera camera 
) const
protectedpure virtual

Compute the LOD value for a given movable object relative to a given camera.

Implemented in Ogre::ScreenRatioPixelCountLodStrategy, Ogre::AbsolutePixelCountLodStrategy, and Ogre::DistanceLodStrategyBase.

static bool Ogre::LodStrategy::isSorted ( const Mesh::LodValueArray values)
static

Determine if the LOD values are sorted from greatest detail to least detail.

static void Ogre::LodStrategy::lodSet ( ObjectData t,
Real  lodValues[ARRAY_PACKED_REALS] 
)
inlinestatic
virtual void Ogre::LodStrategy::lodUpdateImpl ( const size_t  numNodes,
ObjectData  t,
const Camera camera,
Real  bias 
) const
pure virtual
template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

static void Ogre::LodStrategy::sort ( Mesh::MeshLodUsageList meshLodUsageList)
static

Sort mesh LOD usage list from greatest to least detail.

virtual Real Ogre::LodStrategy::transformBias ( Real  factor) const
pure virtual

Transform LOD bias so it only needs to be multiplied by the LOD value.

Implemented in Ogre::DistanceLodStrategyBase, and Ogre::PixelCountLodStrategyBase.

virtual Real Ogre::LodStrategy::transformUserValue ( Real  userValue) const
virtual

Transform user supplied value to internal value.

Remarks
By default, performs no transformation.
Do not throw exceptions for invalid values here, as the LOD strategy may be changed such that the values become valid.

Reimplemented in Ogre::DistanceLodStrategyBase, and Ogre::PixelCountLodStrategyBase.

Member Data Documentation

String Ogre::LodStrategy::mName
protected

Name of this strategy.

Definition at line 57 of file OgreLodStrategy.h.


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