Ogre::DistanceLodStrategy Class Reference
[LOD]

Level of detail strategy based on distance from camera. More...

#include <OgreDistanceLodStrategy.h>

Inheritance diagram for Ogre::DistanceLodStrategy:

Public Member Functions
	DistanceLodStrategy ()
	Default constructor.
virtual Real	getBaseValue () const
virtual Real	transformBias (Real factor) const
virtual Real	transformUserValue (Real userValue) const
virtual ushort	getIndex (Real value, const Mesh::MeshLodUsageList &meshLodUsageList) const
virtual ushort	getIndex (Real value, const Material::LodValueList &materialLodValueList) const
virtual void	sort (Mesh::MeshLodUsageList &meshLodUsageList) const
virtual bool	isSorted (const Mesh::LodValueList &values) const
void	setReferenceView (Real viewportWidth, Real viewportHeight, Radian fovY)
	Sets the reference view upon which the distances were based.
void	setReferenceViewEnabled (bool value)
	Enables to disables use of the reference view.
bool	getReferenceViewEnabled () const
	Determine if use of the reference view is enabled.
Real	getValue (const MovableObject movableObject, const Camera camera) const
	Compute the lod value for a given movable object relative to a given camera.
void	assertSorted (const Mesh::LodValueList &values) const
	Assert that the lod values are sorted from greatest detail to least detail.
const String &	getName () const
	Get the name of this strategy.
void *	operator new (size_t sz, const char file, int line, const char func)
	operator new, with debug line info
void *	operator new (size_t sz)
void *	operator new (size_t sz, void *ptr)
	placement operator new
void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info
void *	operator new[] (size_t sz)
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 *)
Static Public Member Functions
static DistanceLodStrategy &	getSingleton (void)
	Override standard Singleton retrieval.
static DistanceLodStrategy *	getSingletonPtr (void)
	Override standard Singleton retrieval.
Protected Member Functions
virtual Real	getValueImpl (const MovableObject movableObject, const Camera camera) const
Static Protected Member Functions
static bool	isSortedAscending (const Mesh::LodValueList &values)
	Implementation of isSorted suitable for ascending values.
static bool	isSortedDescending (const Mesh::LodValueList &values)
	Implementation of isSorted suitable for descending values.
static void	sortAscending (Mesh::MeshLodUsageList &meshLodUsageList)
	Implementation of sort suitable for ascending values.
static void	sortDescending (Mesh::MeshLodUsageList &meshLodUsageList)
	Implementation of sort suitable for descending values.
static ushort	getIndexAscending (Real value, const Mesh::MeshLodUsageList &meshLodUsageList)
	Implementation of getIndex suitable for ascending values.
static ushort	getIndexAscending (Real value, const Material::LodValueList &materialLodValueList)
	Implementation of getIndex suitable for ascending values.
static ushort	getIndexDescending (Real value, const Mesh::MeshLodUsageList &meshLodUsageList)
	Implementation of getIndex suitable for descending values.
static ushort	getIndexDescending (Real value, const Material::LodValueList &materialLodValueList)
	Implementation of getIndex suitable for descending values.
Protected Attributes
String	mName
	Name of this strategy.
Static Protected Attributes
static DistanceLodStrategy *	msSingleton
Private Attributes
bool	mReferenceViewEnabled
Real	mReferenceViewValue

Detailed Description

Level of detail strategy based on distance from camera.

Definition at line 46 of file OgreDistanceLodStrategy.h.

Constructor & Destructor Documentation

Ogre::DistanceLodStrategy::DistanceLodStrategy ( )

Default constructor.

Member Function Documentation

void Ogre::LodStrategy::assertSorted ( const Mesh::LodValueList & values ) const [inherited]

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

virtual Real Ogre::DistanceLodStrategy::getBaseValue ( ) const [virtual]

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

Implements Ogre::LodStrategy.

virtual ushort Ogre::DistanceLodStrategy::getIndex	(	Real	value,
		const Material::LodValueList &	materialLodValueList
	)			const `[virtual]`

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

Implements Ogre::LodStrategy.

virtual ushort Ogre::DistanceLodStrategy::getIndex	(	Real	value,
		const Mesh::MeshLodUsageList &	meshLodUsageList
	)			const `[virtual]`

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

Implements Ogre::LodStrategy.

static ushort Ogre::LodStrategy::getIndexAscending	(	Real	value,
		const Material::LodValueList &	materialLodValueList
	)			`[static, protected, inherited]`

Implementation of getIndex suitable for ascending values.

static ushort Ogre::LodStrategy::getIndexAscending	(	Real	value,
		const Mesh::MeshLodUsageList &	meshLodUsageList
	)			`[static, protected, inherited]`

Implementation of getIndex suitable for ascending values.

static ushort Ogre::LodStrategy::getIndexDescending	(	Real	value,
		const Material::LodValueList &	materialLodValueList
	)			`[static, protected, inherited]`

Implementation of getIndex suitable for descending values.

static ushort Ogre::LodStrategy::getIndexDescending	(	Real	value,
		const Mesh::MeshLodUsageList &	meshLodUsageList
	)			`[static, protected, inherited]`

Implementation of getIndex suitable for descending values.

const String& Ogre::LodStrategy::getName ( void ) const [inherited]

Get the name of this strategy.

Definition at line 103 of file OgreLodStrategy.h.

bool Ogre::DistanceLodStrategy::getReferenceViewEnabled ( ) const

Determine if use of the reference view is enabled.

static DistanceLodStrategy& Ogre::DistanceLodStrategy::getSingleton ( void ) [static]

Override standard Singleton retrieval.

Remarks:: Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

: This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

Reimplemented from Ogre::Singleton< DistanceLodStrategy >.

static DistanceLodStrategy* Ogre::DistanceLodStrategy::getSingletonPtr ( void ) [static]

Override standard Singleton retrieval.

Remarks:: Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

: This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

Reimplemented from Ogre::Singleton< DistanceLodStrategy >.

Real Ogre::LodStrategy::getValue	(	const MovableObject *	movableObject,
		const Camera *	camera
	)			const `[inherited]`

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

virtual Real Ogre::DistanceLodStrategy::getValueImpl	(	const MovableObject *	movableObject,
		const Camera *	camera
	)			const `[protected, virtual]`

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

Implements Ogre::LodStrategy.

virtual bool Ogre::DistanceLodStrategy::isSorted ( const Mesh::LodValueList & values ) const [virtual]

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

Implements Ogre::LodStrategy.

static bool Ogre::LodStrategy::isSortedAscending ( const Mesh::LodValueList & values ) [static, protected, inherited]

Implementation of isSorted suitable for ascending values.

static bool Ogre::LodStrategy::isSortedDescending ( const Mesh::LodValueList & values ) [static, protected, inherited]

Implementation of isSorted suitable for descending values.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)			`[inherited]`

Definition at line 107 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		void *
	)			`[inherited]`

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void * ptr ) [inherited]

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[]	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)			`[inherited]`

Definition at line 118 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void * ptr ) [inherited]

Definition at line 112 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		void *	ptr
	)			`[inherited]`

placement operator new

Definition at line 78 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 72 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

operator new, with debug line info

Definition at line 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 90 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

array operator new, with debug line info

Definition at line 85 of file OgreMemoryAllocatedObject.h.

void Ogre::DistanceLodStrategy::setReferenceView	(	Real	viewportWidth,
		Real	viewportHeight,
		Radian	fovY
	)

Sets the reference view upon which the distances were based.

Note:: This automatically enables use of the reference view.; There is no corresponding get method for these values as they are not saved, but used to compute a reference value.

void Ogre::DistanceLodStrategy::setReferenceViewEnabled ( bool value )

Enables to disables use of the reference view.

Note:: Do not enable use of the reference view before setting it.

virtual void Ogre::DistanceLodStrategy::sort ( Mesh::MeshLodUsageList & meshLodUsageList ) const [virtual]

Sort mesh lod usage list from greatest to least detail.

Implements Ogre::LodStrategy.

static void Ogre::LodStrategy::sortAscending ( Mesh::MeshLodUsageList & meshLodUsageList ) [static, protected, inherited]

Implementation of sort suitable for ascending values.

static void Ogre::LodStrategy::sortDescending ( Mesh::MeshLodUsageList & meshLodUsageList ) [static, protected, inherited]

Implementation of sort suitable for descending values.

virtual Real Ogre::DistanceLodStrategy::transformBias ( Real factor ) const [virtual]

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

Implements Ogre::LodStrategy.

virtual Real Ogre::DistanceLodStrategy::transformUserValue ( Real userValue ) const [virtual]

Transforum 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 from Ogre::LodStrategy.