Ogre::DistanceLodBoxStrategy Class Reference

Level of detail strategy based on distance from camera to an object's bounding box. More...

#include <OgreDistanceLodStrategy.h>

Inheritance diagram for Ogre::DistanceLodBoxStrategy:

Public Member Functions
	DistanceLodBoxStrategy ()
	Default constructor. More...
Real	getBaseValue () const override
	Get the value of the first (highest) level of detail. More...
const String &	getName () const
	Get the name of this strategy. More...
Real	getSquaredDepth (const MovableObject *movableObject, const Ogre::Camera *camera) const override
Real	getValue (const MovableObject *movableObject, const Camera *camera) const
	Compute the LOD value for a given movable object relative to a given camera. More...
bool	isReferenceViewEnabled () const
	Determine if use of the reference view is enabled. More...
void	lodUpdateImpl (const size_t numNodes, ObjectData t, const Camera *camera, Real bias) const override
void	operator delete (void *ptr)
void	operator delete (void *ptr, const char *, int, const char *)
void	operator delete (void *ptr, void *)
void	operator delete[] (void *ptr)
void	operator delete[] (void *ptr, const char *, int, const char *)
void *	operator new (size_t sz)
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 *ptr)
	placement operator new More...
void *	operator new[] (size_t sz)
void *	operator new[] (size_t sz, const char *file, int line, const char *func)
	array operator new, with debug line info More...
void	setReferenceView (Real viewportWidth, Real viewportHeight, Radian fovY)
	Sets the reference view upon which the distances were based. More...
void	setReferenceViewEnabled (bool value)
	Enables to disables use of the reference view. More...
Real	transformBias (Real factor) const override
	Transform LOD bias so it only needs to be multiplied by the LOD value. More...
Real	transformUserValue (Real userValue) const override
	Transform user supplied value to internal value. More...

Static Public Member Functions
static DistanceLodBoxStrategy &	getSingleton ()
	Override standard Singleton retrieval. More...
static DistanceLodBoxStrategy *	getSingletonPtr ()
	Override standard Singleton retrieval. More...
static void	lodSet (ObjectData &t, Real lodValues[ARRAY_PACKED_REALS])

Detailed Description

Level of detail strategy based on distance from camera to an object's bounding box.

Remarks

The purpose of the reference view is to ensure a consistent experience for all users. Monitors of different resolutions and aspect ratios will each have different results for the distance queries.

It depends on gameplay testing. If all testers had 16:9 monitors and 110° FOV, then that's the value you should enter (to ensure as much as possible the experience stays consistent for all other users who don't have a 16:9 monitor and/or use a different FOV).

If all your testers had 4:3 monitors, then enter a 4:3 resolution.

If all your testers had varying resolutions or you just didn't care, then this feature is useless for you and should be disabled (default: disabled).

Constructor & Destructor Documentation

DistanceLodBoxStrategy()

Ogre::DistanceLodBoxStrategy::DistanceLodBoxStrategy

(

)

Default constructor.

Member Function Documentation

getBaseValue()

Real Ogre::DistanceLodStrategyBase::getBaseValue ( ) const

overridevirtualinherited

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

Implements Ogre::LodStrategy.

getName()

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

inlineinherited

Get the name of this strategy.

getSingleton()

static DistanceLodBoxStrategy& Ogre::DistanceLodBoxStrategy::getSingleton ( )

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.

getSingletonPtr()

static DistanceLodBoxStrategy* Ogre::DistanceLodBoxStrategy::getSingletonPtr ( )

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.

getSquaredDepth()

Real Ogre::DistanceLodBoxStrategy::getSquaredDepth ( const MovableObject *  movableObject, const Ogre::Camera *  camera  ) const

overridevirtual

Implements Ogre::DistanceLodStrategyBase.

getValue()

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.

isReferenceViewEnabled()

bool Ogre::DistanceLodStrategyBase::isReferenceViewEnabled ( ) const

inherited

Determine if use of the reference view is enabled.

lodSet()

static void Ogre::LodStrategy::lodSet ( ObjectData &  t, Real  lodValues[ARRAY_PACKED_REALS]  )

inlinestaticinherited

lodUpdateImpl()

void Ogre::DistanceLodStrategyBase::lodUpdateImpl ( const size_t  numNodes, ObjectData  t, const Camera *  camera, Real  bias  ) const

overridevirtualinherited

Implements Ogre::LodStrategy.

operator delete() [1/3]

template<class Alloc >

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

inlineinherited

operator delete() [2/3]

template<class Alloc >

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

inlineinherited

operator delete() [3/3]

template<class Alloc >

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

inlineinherited

operator delete[]() [1/2]

template<class Alloc >

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

inlineinherited

operator delete[]() [2/2]

template<class Alloc >

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

inlineinherited

operator new() [1/3]

template<class Alloc >

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

inlineinherited

operator new() [2/3]

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

operator new() [3/3]

template<class Alloc >

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

inlineinherited

placement operator new

operator new[]() [1/2]

template<class Alloc >

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

inlineinherited

operator new[]() [2/2]

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

setReferenceView()

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

inherited

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.

setReferenceViewEnabled()

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

inherited

Enables to disables use of the reference view.

Note

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

transformBias()

Real Ogre::DistanceLodStrategyBase::transformBias ( Real  factor ) const

overridevirtualinherited

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

Implements Ogre::LodStrategy.

transformUserValue()

Real Ogre::DistanceLodStrategyBase::transformUserValue ( Real  userValue ) const

overridevirtualinherited

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

---

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

• OgreDistanceLodStrategy.h