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.

virtual Real	getBaseValue () const
	Get the value of the first (highest) level of detail.

const String &	getName () const
	Get the name of this strategy.

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

Real	getValue (const MovableObject movableObject, const Camera camera) const
	Compute the LOD value for a given movable object relative to a given camera.

bool	isReferenceViewEnabled () const
	Determine if use of the reference view is enabled.

virtual void	lodUpdateImpl (const size_t numNodes, ObjectData t, const Camera *camera, Real bias) const

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

void *	operator new (size_t sz, void *ptr)
	placement operator new

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

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.

virtual Real	transformBias (Real factor) const
	Transform LOD bias so it only needs to be multiplied by the LOD value.

virtual Real	transformUserValue (Real userValue) const
	Transform user supplied value to internal value.

Static Public Member Functions
static void	assertSorted (const v1::Mesh::LodValueArray &values)
	Assert that the LOD values are sorted from greatest detail to least detail.

static ushort	getIndex (Real value, const Material::LodValueArray &materialLodValueArray)
	Get the index of the LOD usage which applies to a given value.

static ushort	getIndex (Real value, const v1::Mesh::MeshLodUsageList &meshLodUsageList)
	Get the index of the LOD usage which applies to a given value.

static DistanceLodBoxStrategy &	getSingleton (void)
	Override standard Singleton retrieval.

static DistanceLodBoxStrategy *	getSingletonPtr (void)
	Override standard Singleton retrieval.

static bool	isSorted (const v1::Mesh::LodValueArray &values)
	Determine if the LOD values are sorted from greatest detail to least detail.

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

static void	sort (v1::Mesh::MeshLodUsageList &meshLodUsageList)
	Sort mesh LOD usage list from greatest to least detail.

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

◆ assertSorted()

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

staticinherited

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

◆ getBaseValue()

virtual Real Ogre::DistanceLodStrategyBase::getBaseValue ( ) const

virtualinherited

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

Implements Ogre::LodStrategy.

◆ getIndex() [1/2]

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

staticinherited

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

◆ getIndex() [2/2]

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

staticinherited

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

◆ getName()

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

inlineinherited

Get the name of this strategy.

◆ getSingleton()

static DistanceLodBoxStrategy & Ogre::DistanceLodBoxStrategy::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.

◆ getSingletonPtr()

static DistanceLodBoxStrategy * Ogre::DistanceLodBoxStrategy::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.

◆ getSquaredDepth()

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

virtual

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.

◆ isSorted()

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

staticinherited

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

◆ lodSet()

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

inlinestaticinherited

◆ lodUpdateImpl()

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

virtualinherited

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.

◆ sort()

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

staticinherited

Sort mesh LOD usage list from greatest to least detail.

◆ transformBias()

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

virtualinherited

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

Implements Ogre::LodStrategy.

◆ transformUserValue()

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

virtualinherited

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

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ DistanceLodBoxStrategy()

Member Function Documentation

◆ assertSorted()

◆ getBaseValue()

◆ getIndex() [1/2]

◆ getIndex() [2/2]

◆ getName()

◆ getSingleton()

◆ getSingletonPtr()

◆ getSquaredDepth()

◆ getValue()

◆ isReferenceViewEnabled()

◆ isSorted()

◆ lodSet()

◆ lodUpdateImpl()

◆ operator delete() [1/3]

◆ operator delete() [2/3]

◆ operator delete() [3/3]

◆ operator delete[]() [1/2]

◆ operator delete[]() [2/2]

◆ operator new() [1/3]

◆ operator new() [2/3]

◆ operator new() [3/3]

◆ operator new[]() [1/2]

◆ operator new[]() [2/2]

◆ setReferenceView()

◆ setReferenceViewEnabled()

◆ sort()

◆ transformBias()

◆ transformUserValue()