OGRE-Next  3.0.0unstable
Object-Oriented Graphics Rendering Engine
Ogre::ScreenRatioPixelCountLodStrategy Class Reference

The ScreenRatioPixelCountLodStrategy class Implement a strategy which calculates LOD ratios based on coverage in screen ratios in the range [-1.0; 0.0] where -1.0 means the object is covering the whole screen and 0 covering almost nothing in the screen (very tiny). More...

#include <OgrePixelCountLodStrategy.h>

+ Inheritance diagram for Ogre::ScreenRatioPixelCountLodStrategy:

Public Member Functions

 ScreenRatioPixelCountLodStrategy ()
 Default constructor. More...
 
Real getValueImpl (const MovableObject *movableObject, const Camera *camera) const override
 Compute the LOD value for a given movable object relative to a given camera. More...
 
void lodUpdateImpl (const size_t numNodes, ObjectData t, const Camera *camera, Real bias) const override
 
- Public Member Functions inherited from Ogre::PixelCountLodStrategyBase
 PixelCountLodStrategyBase (const String &name)
 Default constructor. More...
 
Real getBaseValue () const override
 Get the value of the first (highest) level of detail. 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...
 
- Public Member Functions inherited from Ogre::LodStrategy
 LodStrategy (const String &name)
 Constructor accepting name. More...
 
virtual ~LodStrategy ()
 Virtual destructor. 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< ScreenRatioPixelCountLodStrategy >
 Singleton ()
 
 ~Singleton ()
 

Static Public Member Functions

static ScreenRatioPixelCountLodStrategygetSingleton ()
 Override standard Singleton retrieval. More...
 
static ScreenRatioPixelCountLodStrategygetSingletonPtr ()
 Override standard Singleton retrieval. More...
 
- Static Public Member Functions inherited from Ogre::LodStrategy
static void lodSet (ObjectData &t, Real lodValues[ARRAY_PACKED_REALS])
 
- Static Public Member Functions inherited from Ogre::Singleton< ScreenRatioPixelCountLodStrategy >
static ScreenRatioPixelCountLodStrategygetSingleton ()
 
static ScreenRatioPixelCountLodStrategygetSingletonPtr ()
 

Detailed Description

The ScreenRatioPixelCountLodStrategy class Implement a strategy which calculates LOD ratios based on coverage in screen ratios in the range [-1.0; 0.0] where -1.0 means the object is covering the whole screen and 0 covering almost nothing in the screen (very tiny).

Note however that:

  1. Values beyond -1.0 are possible (it just means the object is bigger than the screen)
  2. It's an approximation

Constructor & Destructor Documentation

◆ ScreenRatioPixelCountLodStrategy()

Ogre::ScreenRatioPixelCountLodStrategy::ScreenRatioPixelCountLodStrategy ( )

Default constructor.

Member Function Documentation

◆ getSingleton()

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

◆ getValueImpl()

Real Ogre::ScreenRatioPixelCountLodStrategy::getValueImpl ( const MovableObject movableObject,
const Camera camera 
) const
overridevirtual

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

Implements Ogre::LodStrategy.

◆ lodUpdateImpl()

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

Implements Ogre::LodStrategy.


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