Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Related Pages

# Ogre::TerrainOptions Class Reference

A simple class for encapsulating parameters which are commonly needed by both TerrainSceneManager and TerrainRenderable. More...

`#include <OgreTerrainRenderable.h>`

List of all members.

## Public Methods

| TerrainOptions ()

## Public Attributes

size_t | pageSize
| The size of one edge of a terrain page, in vertices.
size_t | tileSize
| The size of one edge of a terrain tile, in vertices.
size_t | tilesPerPage
| Precalculated number of tiles per page.
const Camera * | primaryCamera
| The primary camera, used for error metric calculation and page choice.
size_t | maxGeoMipMapLevel
| The maximum terrain geo-mipmap level.
Vector3 | scale
| The scale factor to apply to the terrain (each vertex is 1 unscaled unit away from the next, and height is from 0 to 1).
size_t | maxPixelError
| The maximum pixel error allowed.
bool | useTriStrips
| Whether we should use triangle strips.
size_t | detailTile
| The number of times to repeat a detail texture over a tile.
bool | lodMorph
| Whether LOD morphing is enabled.
Real | lodMorphStart
| At what point (parametric) should LOD morphing start.
bool | lit
| Whether dynamic lighting is enabled.
bool | coloured
| Whether vertex colours are enabled.
Material * | terrainMaterial
| Pointer to the material to use to render the terrain.

## Detailed Description

A simple class for encapsulating parameters which are commonly needed by both TerrainSceneManager and TerrainRenderable.

Definition at line 88 of file OgreTerrainRenderable.h.

## Constructor & Destructor Documentation

Ogre::TerrainOptions::TerrainOptions | ( |  | ) |

| Definition at line 91 of file OgreTerrainRenderable.h. References coloured, detailTile, lit, lodMorph, lodMorphStart, maxGeoMipMapLevel, maxPixelError, pageSize, primaryCamera, scale, terrainMaterial, tileSize, tilesPerPage, and useTriStrips.

## Member Data Documentation

bool Ogre::TerrainOptions::coloured

| Whether vertex colours are enabled. Definition at line 134 of file OgreTerrainRenderable.h. Referenced by Ogre::TerrainSceneManager::loadConfig(), Ogre::TerrainSceneManager::setUseVertexColours(), and TerrainOptions().

size_t Ogre::TerrainOptions::detailTile

| The number of times to repeat a detail texture over a tile. Definition at line 126 of file OgreTerrainRenderable.h. Referenced by Ogre::TerrainRenderable::initialise(), Ogre::TerrainSceneManager::setDetailTextureRepeat(), and TerrainOptions().

bool Ogre::TerrainOptions::lit

| Whether dynamic lighting is enabled. Definition at line 132 of file OgreTerrainRenderable.h. Referenced by Ogre::TerrainRenderable::_calculateNormals(), Ogre::TerrainRenderable::_getNormalAt(), Ogre::TerrainRenderable::initialise(), Ogre::TerrainSceneManager::loadConfig(), Ogre::TerrainSceneManager::setupTerrainMaterial(), Ogre::TerrainSceneManager::setUseVertexNormals(), and TerrainOptions().

bool Ogre::TerrainOptions::lodMorph

| Whether LOD morphing is enabled. Definition at line 128 of file OgreTerrainRenderable.h. Referenced by Ogre::TerrainRenderable::_calculateMinLevelDist2(), Ogre::TerrainRenderable::_notifyCurrentCamera(), Ogre::TerrainRenderable::initialise(), Ogre::TerrainSceneManager::setupTerrainMaterial(), Ogre::TerrainSceneManager::setUseLODMorph(), and TerrainOptions().

Real Ogre::TerrainOptions::lodMorphStart

| At what point (parametric) should LOD morphing start. Definition at line 130 of file OgreTerrainRenderable.h. Referenced by Ogre::TerrainRenderable::_notifyCurrentCamera(), Ogre::TerrainSceneManager::setLODMorphStart(), and TerrainOptions().

size_t Ogre::TerrainOptions::maxGeoMipMapLevel

| The maximum terrain geo-mipmap level. Definition at line 117 of file OgreTerrainRenderable.h. Referenced by Ogre::TerrainRenderable::_calculateMinLevelDist2(), Ogre::TerrainRenderable::_notifyCurrentCamera(), Ogre::TerrainSceneManager::getMaxGeoMipMapLevel(), Ogre::TerrainRenderable::initialise(), Ogre::TerrainSceneManager::setMaxGeoMipMapLevel(), and TerrainOptions().

size_t Ogre::TerrainOptions::maxPixelError

| The maximum pixel error allowed. Definition at line 122 of file OgreTerrainRenderable.h. Referenced by Ogre::TerrainRenderable::_calculateCFactor(), Ogre::TerrainSceneManager::getMaxPixelError(), Ogre::TerrainSceneManager::setMaxPixelError(), and TerrainOptions().

size_t Ogre::TerrainOptions::pageSize

The size of one edge of a terrain page, in vertices.

Definition at line 109 of file OgreTerrainRenderable.h.

Referenced by Ogre::TerrainSceneManager::getPageSize(), Ogre::TerrainRenderable::initialise(), Ogre::TerrainSceneManager::loadConfig(), Ogre::TerrainSceneManager::selectPageSource(), Ogre::TerrainSceneManager::setPageSize(), Ogre::TerrainSceneManager::setWorldGeometry(), and TerrainOptions().

const Camera* Ogre::TerrainOptions::primaryCamera

| The primary camera, used for error metric calculation and page choice. Definition at line 115 of file OgreTerrainRenderable.h. Referenced by Ogre::TerrainRenderable::_calculateCFactor(), Ogre::TerrainSceneManager::createCamera(), Ogre::TerrainSceneManager::setPrimaryCamera(), and TerrainOptions().

Vector3 Ogre::TerrainOptions::scale

| The scale factor to apply to the terrain (each vertex is 1 unscaled unit away from the next, and height is from 0 to 1). Definition at line 120 of file OgreTerrainRenderable.h. Referenced by Ogre::TerrainSceneManager::getScale(), Ogre::TerrainRenderable::initialise(), Ogre::TerrainSceneManager::setScale(), Ogre::TerrainSceneManager::setWorldGeometry(), and TerrainOptions().

Material* Ogre::TerrainOptions::terrainMaterial

| Pointer to the material to use to render the terrain. Definition at line 136 of file OgreTerrainRenderable.h. Referenced by Ogre::TerrainSceneManager::getTerrainMaterial(), Ogre::TerrainSceneManager::setupTerrainMaterial(), and TerrainOptions().

size_t Ogre::TerrainOptions::tileSize

The size of one edge of a terrain tile, in vertices.

Definition at line 111 of file OgreTerrainRenderable.h.

Referenced by Ogre::TerrainRenderable::_calculateMinLevelDist2(), Ogre::TerrainRenderable::_calculateNormals(), Ogre::TerrainRenderable::_generateVertexLighting(), Ogre::TerrainRenderable::createDeltaBuffer(), Ogre::TerrainRenderable::generateTriListIndexes(), Ogre::TerrainRenderable::generateTriStripIndexes(), Ogre::TerrainRenderable::getHeightAt(), Ogre::TerrainSceneManager::getTileSize(), Ogre::TerrainRenderable::initialise(), Ogre::TerrainSceneManager::selectPageSource(), Ogre::TerrainSceneManager::setTileSize(), Ogre::TerrainRenderable::stitchEdge(), and TerrainOptions().

size_t Ogre::TerrainOptions::tilesPerPage

| Precalculated number of tiles per page. Definition at line 113 of file OgreTerrainRenderable.h. Referenced by TerrainOptions().

bool Ogre::TerrainOptions::useTriStrips

| Whether we should use triangle strips. Definition at line 124 of file OgreTerrainRenderable.h. Referenced by Ogre::TerrainRenderable::_calculateMinLevelDist2(), Ogre::TerrainRenderable::getIndexData(), Ogre::TerrainRenderable::getRenderOperation(), Ogre::TerrainSceneManager::setUseTriStrips(), and TerrainOptions().

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

- OgreTerrainRenderable.h

Copyright © 2002-2003 by The OGRE Team
Last modified Sun Nov 28 19:50:02 2004