OGRE  1.12.8
Object-Oriented Graphics Rendering Engine
Ogre::DistanceLodSphereStrategy Class Reference

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

#include <OgreDistanceLodStrategy.h>

+ Inheritance diagram for Ogre::DistanceLodSphereStrategy:

Public Member Functions

 DistanceLodSphereStrategy ()
 Default constructor. More...
 
Real getSquaredDepth (const MovableObject *movableObject, const Ogre::Camera *camera) const
 Get the squared depth from camera to the LOD object. More...
 
- Public Member Functions inherited from Ogre::DistanceLodStrategyBase
 DistanceLodStrategyBase (const String &name)
 Default constructor. More...
 
virtual Real getBaseValue () const
 Get the value of the first (highest) level of detail. More...
 
virtual ushort getIndex (Real value, const Material::LodValueList &materialLodValueList) const
 Get the index of the LOD usage which applies to a given value. More...
 
virtual ushort getIndex (Real value, const Mesh::MeshLodUsageList &meshLodUsageList) const
 Get the index of the LOD usage which applies to a given value. More...
 
bool isReferenceViewEnabled () const
 Determine if use of the reference view is enabled. More...
 
virtual bool isSorted (const Mesh::LodValueList &values) const
 Determine if the LOD values are sorted from greatest detail to least detail. 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...
 
virtual void sort (Mesh::MeshLodUsageList &meshLodUsageList) const
 Sort mesh LOD usage list from greatest to least detail. More...
 
virtual Real transformBias (Real factor) const
 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...
 
- Public Member Functions inherited from Ogre::LodStrategy
 LodStrategy (const String &name)
 Constructor accepting name. More...
 
virtual ~LodStrategy ()
 Virtual destructor. More...
 
void assertSorted (const Mesh::LodValueList &values) const
 Assert that the LOD values are sorted from greatest detail to least 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...
 
- Public Member Functions inherited from Ogre::Singleton< DistanceLodSphereStrategy >
 Singleton (void)
 
 ~Singleton (void)
 

Static Public Member Functions

static DistanceLodSphereStrategygetSingleton (void)
 Get the singleton instance. More...
 
static DistanceLodSphereStrategygetSingletonPtr (void)
 Get the singleton instance. More...
 
- Static Public Member Functions inherited from Ogre::Singleton< DistanceLodSphereStrategy >
static DistanceLodSphereStrategygetSingleton (void)
 Get the singleton instance. More...
 
static DistanceLodSphereStrategygetSingletonPtr (void)
 Get the singleton instance. More...
 

Detailed Description

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

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

◆ DistanceLodSphereStrategy()

Ogre::DistanceLodSphereStrategy::DistanceLodSphereStrategy ( )

Default constructor.

Member Function Documentation

◆ getSquaredDepth()

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

Get the squared depth from camera to the LOD object.

Implements Ogre::DistanceLodStrategyBase.

◆ getSingleton()

static DistanceLodSphereStrategy& Ogre::DistanceLodSphereStrategy::getSingleton ( void  )
static

Get the singleton instance.

◆ getSingletonPtr()

static DistanceLodSphereStrategy* Ogre::DistanceLodSphereStrategy::getSingletonPtr ( void  )
static

Get the singleton instance.


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