Ogre::DistanceLodStrategy Class Referenceabstract
Core » LOD

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

`#include <OgreDistanceLodStrategy.h>`

Inheritance diagram for Ogre::DistanceLodStrategy:
[legend]

## Public Member Functions

| DistanceLodStrategy (const String &name)
| Default constructor. More...
void | assertSorted (const Mesh::LodValueList &values) const
| Assert that the LOD values are sorted from greatest detail to least detail. More...
virtual Real | getBaseValue () const
| Get the value of the first (highest) level of detail. 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...
virtual ushort | getIndex (Real value, const Material::LodValueList &materialLodValueList) const
| Get the index of the LOD usage which applies to a given value. More...
const String & | getName () const
| Get the name of this strategy. More...
virtual Real | getSquaredDepth (const MovableObject *movableObject, const Ogre::Camera *camera) const =0
| Get the squared depth from camera to the LOD object. 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...
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 | 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 *)
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 * | operator new (size_t sz, void *ptr)
| placement operator new More...
void * | operator new[] (size_t sz, const char *file, int line, const char *func)
| array operator new, with debug line info More...
void * | operator new[] (size_t sz)
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...

## Protected Member Functions

virtual Real | getValueImpl (const MovableObject *movableObject, const Camera *camera) const
| Compute the LOD value for a given movable object relative to a given camera. More...

## Static Protected Member Functions

static ushort | getIndexAscending (Real value, const Mesh::MeshLodUsageList &meshLodUsageList)
| Implementation of getIndex suitable for ascending values. More...
static ushort | getIndexAscending (Real value, const Material::LodValueList &materialLodValueList)
| Implementation of getIndex suitable for ascending values. More...
static ushort | getIndexDescending (Real value, const Mesh::MeshLodUsageList &meshLodUsageList)
| Implementation of getIndex suitable for descending values. More...
static ushort | getIndexDescending (Real value, const Material::LodValueList &materialLodValueList)
| Implementation of getIndex suitable for descending values. More...
static bool | isSortedAscending (const Mesh::LodValueList &values)
| Implementation of isSorted suitable for ascending values. More...
static bool | isSortedDescending (const Mesh::LodValueList &values)
| Implementation of isSorted suitable for descending values. More...
static void | sortAscending (Mesh::MeshLodUsageList &meshLodUsageList)
| Implementation of sort suitable for ascending values. More...
static void | sortDescending (Mesh::MeshLodUsageList &meshLodUsageList)
| Implementation of sort suitable for descending values. More...

## Protected Attributes

String | mName
| Name of this strategy. More...

## Private Attributes

bool | mReferenceViewEnabled
Real | mReferenceViewValue

## Detailed Description

Level of detail strategy based on distance from camera.

This is an abstract base class for DistanceLodBoxStrategy and DistanceLodSphereStrategy.

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).

Definition at line 55 of file OgreDistanceLodStrategy.h.

## Constructor & Destructor Documentation

## DistanceLodStrategy()

Ogre::DistanceLodStrategy::DistanceLodStrategy | ( | const String & | name | ) |

Default constructor.

## Member Function Documentation

## assertSorted()

void Ogre::LodStrategy::assertSorted | ( | const Mesh::LodValueList & | values | ) | const

inherited

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

## getBaseValue()

virtual Real Ogre::DistanceLodStrategy::getBaseValue | ( |  | ) | const

virtual

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

Implements Ogre::LodStrategy.

## getIndex() [1/2]

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.

## getIndex() [2/2]

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.

## getIndexAscending() [1/2]

static ushort Ogre::LodStrategy::getIndexAscending | ( | Real | value,
|  | const Mesh::MeshLodUsageList & | meshLodUsageList
| ) |  |

static protected inherited

Implementation of getIndex suitable for ascending values.

## getIndexAscending() [2/2]

static ushort Ogre::LodStrategy::getIndexAscending | ( | Real | value,
|  | const Material::LodValueList & | materialLodValueList
| ) |  |

static protected inherited

Implementation of getIndex suitable for ascending values.

## getIndexDescending() [1/2]

static ushort Ogre::LodStrategy::getIndexDescending | ( | Real | value,
|  | const Mesh::MeshLodUsageList & | meshLodUsageList
| ) |  |

static protected inherited

Implementation of getIndex suitable for descending values.

## getIndexDescending() [2/2]

static ushort Ogre::LodStrategy::getIndexDescending | ( | Real | value,
|  | const Material::LodValueList & | materialLodValueList
| ) |  |

static protected inherited

Implementation of getIndex suitable for descending values.

## getName()

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

inherited

Get the name of this strategy.

Definition at line 104 of file OgreLodStrategy.h.

## getSquaredDepth()

virtual Real Ogre::DistanceLodStrategy::getSquaredDepth | ( | const MovableObject * | movableObject,
|  | const Ogre::Camera * | camera
| ) |  | const

pure virtual

Get the squared depth from camera to the LOD object.

Implemented in Ogre::DistanceLodBoxStrategy, and Ogre::DistanceLodSphereStrategy.

## 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.

## getValueImpl()

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.

## isReferenceViewEnabled()

bool Ogre::DistanceLodStrategy::isReferenceViewEnabled | ( |  | ) | const

Determine if use of the reference view is enabled.

## isSorted()

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.

## isSortedAscending()

static bool Ogre::LodStrategy::isSortedAscending | ( | const Mesh::LodValueList & | values | ) |

static protected inherited

Implementation of isSorted suitable for ascending values.

## isSortedDescending()

static bool Ogre::LodStrategy::isSortedDescending | ( | const Mesh::LodValueList & | values | ) |

static protected inherited

Implementation of isSorted suitable for descending values.

## operator delete() [1/3]

template<class Alloc >

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

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

## operator delete() [2/3]

template<class Alloc >

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

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

## operator delete() [3/3]

template<class Alloc >

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

inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

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

template<class Alloc >

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

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

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

template<class Alloc >

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

inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

## operator new() [1/3]

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 68 of file OgreMemoryAllocatedObject.h.

## operator new() [2/3]

template<class Alloc >

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

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

## operator new() [3/3]

template<class Alloc >

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

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

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

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 86 of file OgreMemoryAllocatedObject.h.

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

template<class Alloc >

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

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

## setReferenceView()

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.

## setReferenceViewEnabled()

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.

## sort()

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

virtual

Sort mesh LOD usage list from greatest to least detail.

Implements Ogre::LodStrategy.

## sortAscending()

static void Ogre::LodStrategy::sortAscending | ( | Mesh::MeshLodUsageList & | meshLodUsageList | ) |

static protected inherited

Implementation of sort suitable for ascending values.

## sortDescending()

static void Ogre::LodStrategy::sortDescending | ( | Mesh::MeshLodUsageList & | meshLodUsageList | ) |

static protected inherited

Implementation of sort suitable for descending values.

## transformBias()

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.

## transformUserValue()

virtual Real Ogre::DistanceLodStrategy::transformUserValue | ( | Real | userValue | ) | const

virtual

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.

## Member Data Documentation

## mName

String Ogre::LodStrategy::mName

protected inherited

Name of this strategy.

Definition at line 58 of file OgreLodStrategy.h.

## mReferenceViewEnabled

bool Ogre::DistanceLodStrategy::mReferenceViewEnabled

private

Definition at line 107 of file OgreDistanceLodStrategy.h.

## mReferenceViewValue

Real Ogre::DistanceLodStrategy::mReferenceViewValue

private

Definition at line 108 of file OgreDistanceLodStrategy.h.

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

- OgreDistanceLodStrategy.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.