OGRE  1.12.2
Object-Oriented Graphics Rendering Engine
Ogre::Terrain Class Reference

The main containing class for a chunk of terrain. More...

#include <OgreTerrain.h>

+ Inheritance diagram for Ogre::Terrain:

Classes

class  DefaultGpuBufferAllocator
 Standard implementation of a buffer allocator which re-uses buffers. More...
 
class  GpuBufferAllocator
 Interface used to by the Terrain instance to allocate GPU buffers. More...
 
struct  ImportData
 Structure encapsulating import data that you may use to bootstrap the terrain without loading from a native data stream. More...
 
struct  LayerInstance
 An instance of a layer, with specific texture names. More...
 

Public Types

enum  Alignment { ALIGN_X_Z = 0, ALIGN_X_Y = 1, ALIGN_Y_Z = 2 }
 The alignment of the terrain. More...
 
typedef std::vector< LayerInstanceLayerInstanceList
 
enum  NeighbourIndex {
  NEIGHBOUR_EAST = 0, NEIGHBOUR_NORTHEAST = 1, NEIGHBOUR_NORTH = 2, NEIGHBOUR_NORTHWEST = 3,
  NEIGHBOUR_WEST = 4, NEIGHBOUR_SOUTHWEST = 5, NEIGHBOUR_SOUTH = 6, NEIGHBOUR_SOUTHEAST = 7,
  NEIGHBOUR_COUNT = 8
}
 Neighbour index enumeration - indexed anticlockwise from East like angles. More...
 
typedef std::vector< RealRealVector
 
enum  Space { WORLD_SPACE = 0, LOCAL_SPACE = 1, TERRAIN_SPACE = 2, POINT_SPACE = 3 }
 Enumeration of relative spaces that you might want to use to address the terrain. More...
 

Public Member Functions

 Terrain (SceneManager *sm)
 Constructor. More...
 
virtual ~Terrain ()
 
void _dirtyCompositeMapRect (const Rect &rect)
 Mark a region of the terrain composite map as dirty. More...
 
void _dumpTextures (const String &prefix, const String &suffix)
 Dump textures to files. More...
 
const MaterialPtr_getCompositeMapMaterial () const
 Internal getting of material for the terrain composite map. More...
 
const String_getDerivedResourceGroup () const
 Get the final resource group to use when loading / saving. More...
 
const MaterialPtr_getMaterial () const
 Internal getting of material. More...
 
bool _getMorphRequired () const
 Get whether LOD morphing is needed. More...
 
SceneNode_getRootSceneNode () const
 Get the root scene node for the terrain (internal use only) More...
 
bool _getUseVertexCompression () const
 Whether we're using vertex compression or not. More...
 
void _setCompositeMapRequired (bool compositeMap)
 Request internal implementation options for the terrain material to use, in this case a terrain-wide composite map. More...
 
void _setLightMapRequired (bool lightMap, bool shadowsOnly=false)
 Request internal implementation options for the terrain material to use, in this case a terrain-wide normal map. More...
 
void _setMorphRequired (bool morph)
 Request internal implementation options for the terrain material to use, in this case vertex morphing information. More...
 
void _setNormalMapRequired (bool normalMap)
 Request internal implementation options for the terrain material to use, in this case a terrain-wide normal map. More...
 
void addLayer (Real worldSize=0, const StringVector *textureNames=0)
 Add a new layer to this terrain. More...
 
void addLayer (uint8 index, Real worldSize=0, const StringVector *textureNames=0)
 Add a new layer to this terrain at a specific index. More...
 
void addQueryFlags (uint32 flags)
 As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object. More...
 
Rect calculateHeightDeltas (const Rect &rect)
 Calculate (or recalculate) the delta values of heights between a vertex in its recorded position, and the place it will end up in the LOD in which it is removed. More...
 
PixelBoxcalculateLightmap (const Rect &rect, const Rect &extraTargetRect, Rect &outFinalRect)
 Calculate (or recalculate) the terrain lightmap. More...
 
PixelBoxcalculateNormals (const Rect &rect, Rect &outFinalRect)
 Calculate (or recalculate) the normals on the terrain. More...
 
bool canHandleRequest (const WorkQueue::Request *req, const WorkQueue *srcQ)
 WorkQueue::RequestHandler override. More...
 
bool canHandleResponse (const WorkQueue::Response *res, const WorkQueue *srcQ)
 WorkQueue::ResponseHandler override. More...
 
void convertDirection (Space inSpace, const Vector3 &inDir, Space outSpace, Vector3 &outDir) const
 Convert a direction from one space to another with respect to this terrain. More...
 
Vector3 convertDirection (Space inSpace, const Vector3 &inDir, Space outSpace) const
 Convert a direction from one space to another with respect to this terrain. More...
 
void convertPosition (Space inSpace, const Vector3 &inPos, Space outSpace, Vector3 &outPos) const
 Convert a position from one space to another with respect to this terrain. More...
 
Vector3 convertPosition (Space inSpace, const Vector3 &inPos, Space outSpace) const
 Convert a position from one space to another with respect to this terrain. More...
 
void decreaseLodLevel ()
 Removes highest LOD level loaded. More...
 
void dirty ()
 Mark the entire terrain as dirty. More...
 
void dirtyLightmap ()
 Mark a the entire lightmap as dirty. More...
 
void dirtyLightmapRect (const Rect &rect)
 Mark a region of the lightmap as dirty. More...
 
void dirtyRect (const Rect &rect)
 Mark a region of the terrain as dirty. More...
 
void finaliseHeightDeltas (const Rect &rect, bool cpuData)
 Finalise the height deltas. More...
 
void finaliseLightmap (const Rect &rect, PixelBox *lightmapBox)
 Finalise the lightmap. More...
 
void finaliseNormals (const Rect &rect, PixelBox *normalsBox)
 Finalise the normals. More...
 
void freeTemporaryResources ()
 Free as many resources as possible for optimal run-time memory use. More...
 
const AxisAlignedBoxgetAABB () const
 Get the AABB (local coords) of the entire terrain. More...
 
Alignment getAlignment () const
 Get the alignment of the terrain. More...
 
uint8 getBlendTextureCount () const
 Get the number of blend textures in use. More...
 
uint8 getBlendTextureCount (uint8 numLayers) const
 Get the number of blend textures needed for a given number of layers. More...
 
uint8 getBlendTextureIndex (uint8 layerIndex) const
 Get the index of the blend texture that a given layer uses. More...
 
const StringgetBlendTextureName (uint8 textureIndex) const
 Get the name of the packed blend texture at a specific index. More...
 
Real getBoundingRadius () const
 Get the bounding radius of the entire terrain. More...
 
const TexturePtrgetCompositeMap () const
 Get access to the composite map, if enabled (as requested by the material generator) More...
 
const MaterialPtrgetCompositeMapMaterial () const
 Get the material being used for the terrain composite map. More...
 
uint16 getCompositeMapSize () const
 Get the requested size of composite map for this terrain. More...
 
const float * getDeltaData () const
 Get a pointer to all the delta data for this terrain. More...
 
const float * getDeltaData (long x, long y) const
 Get a pointer to the delta data for a given point. More...
 
const TexturePtrgetGlobalColourMap () const
 Get access to the global colour map, if enabled. More...
 
bool getGlobalColourMapEnabled () const
 Get whether a global colour map is enabled on this terrain. More...
 
uint16 getGlobalColourMapSize () const
 Get the size of the global colour map (if used) More...
 
GpuBufferAllocatorgetGpuBufferAllocator ()
 Get the current buffer allocator. More...
 
float getHeightAtPoint (long x, long y) const
 Get the height data for a given terrain point. More...
 
float getHeightAtTerrainPosition (Real x, Real y) const
 Get the height data for a given terrain position. More...
 
float getHeightAtWorldPosition (Real x, Real y, Real z) const
 Get the height data for a given world position (projecting the point down on to the terrain). More...
 
float getHeightAtWorldPosition (const Vector3 &pos) const
 
float * getHeightData () const
 Get a pointer to all the height data for this terrain. More...
 
float * getHeightData (long x, long y) const
 Get a pointer to the height data for a given point. More...
 
int getHighestLodLoaded () const
 
int getHighestLodPrepared () const
 
TerrainLayerBlendMapgetLayerBlendMap (uint8 layerIndex)
 Retrieve the layer blending map for a given layer, which may be used to edit the blending information for that layer. More...
 
uint16 getLayerBlendMapSize () const
 Get the requested size of the blend maps used to blend between layers for this terrain. More...
 
const TexturePtrgetLayerBlendTexture (uint8 index) const
 Get a blend texture with a given index. More...
 
std::pair< uint8, uint8getLayerBlendTextureIndex (uint8 layerIndex) const
 Get the texture index and colour channel of the blend information for a given layer. More...
 
uint8 getLayerCount () const
 Get the number of layers in this terrain. More...
 
const TerrainLayerDeclarationgetLayerDeclaration () const
 Get the declaration which describes the layers in this terrain. More...
 
const StringgetLayerTextureName (uint8 layerIndex, uint8 samplerIndex) const
 Get the name of the texture bound to a given index within a given layer. More...
 
Real getLayerUVMultiplier (uint8 index) const
 Get the layer UV multiplier. More...
 
Real getLayerWorldSize (uint8 index) const
 How large an area in world space the texture in a terrain layer covers before repeating. More...
 
const TexturePtrgetLightmap () const
 Get access to the lightmap, if enabled (as requested by the material generator) More...
 
uint16 getLightmapSize () const
 Get the requested size of lightmap for this terrain. More...
 
uint16 getLODLevelWhenVertexEliminated (long x, long y) const
 Utility method, get the first LOD Level at which this vertex is no longer included. More...
 
uint16 getLODLevelWhenVertexEliminated (long rowOrColulmn) const
 Utility method, get the first LOD Level at which this vertex is no longer included. More...
 
const MaterialPtrgetMaterial () const
 Get the material being used for the terrain. More...
 
const StringgetMaterialName () const
 Get the name of the material being used for the terrain. More...
 
uint16 getMaxBatchSize () const
 Get the maximum size in vertices along one side of a batch. More...
 
Real getMaxHeight () const
 Get the maximum height of the terrain. More...
 
uint8 getMaxLayers () const
 Get the maximum number of layers supported with the current options. More...
 
uint16 getMinBatchSize () const
 Get the minimum size in vertices along one side of a batch. More...
 
Real getMinHeight () const
 Get the minimum height of the terrain. More...
 
TerraingetNeighbour (NeighbourIndex index) const
 Retrieve the terrain's neighbour, or null if not present. More...
 
uint16 getNumLodLevels () const
 Get the total number of LOD levels in the terrain. More...
 
uint16 getNumLodLevelsPerLeaf () const
 Get the number of LOD levels in a leaf of the terrain quadtree. More...
 
void getPoint (long x, long y, Vector3 *outpos) const
 Get a Vector3 of the world-space point on the terrain, aligned as per options. More...
 
void getPoint (long x, long y, float height, Vector3 *outpos) const
 Get a Vector3 of the world-space point on the terrain, supplying the height data manually (can be more optimal). More...
 
void getPointFromSelfOrNeighbour (long x, long y, Vector3 *outpos) const
 Get a Vector3 of the world-space point on the terrain, aligned as per options. More...
 
void getPointTransform (Matrix4 *outXform) const
 Get a transform which converts Vector4(xindex, yindex, height, 1) into an object-space position including scalings and alignment. More...
 
void getPosition (const Vector3 &TSpos, Vector3 *outWSpos) const
 Convert a position from terrain basis space to world space. More...
 
void getPosition (Real x, Real y, Real z, Vector3 *outWSpos) const
 
const Vector3getPosition () const
 Get the world position of the terrain centre. More...
 
void getPositionAlign (const Vector3 &TSpos, Alignment align, Vector3 *outWSpos) const
 Convert a position from terrain basis space to world space based on a specified alignment. More...
 
void getPositionAlign (Real x, Real y, Real z, Alignment align, Vector3 *outWSpos) const
 
TerrainQuadTreeNodegetQuadTree ()
 Get the top level of the quad tree which is used to divide up the terrain. More...
 
uint32 getQueryFlags (void) const
 Get the query flags for this terrain. More...
 
uint8 getRenderQueueGroup (void) const
 Get the render queue group that this terrain will be rendered into. More...
 
uint16 getResolutionAtLod (uint16 lodLevel) const
 Gets the resolution of the entire terrain (down one edge) at a given LOD level. More...
 
const StringgetResourceGroup () const
 Get the resource group to use when loading / saving. More...
 
SceneManagergetSceneManager () const
 
uint16 getSize () const
 Get the size of the terrain in vertices along one side. More...
 
Real getSkirtSize () const
 The default size of 'skirts' used to hide terrain cracks (default 10, set for new Terrain using TerrainGlobalOptions) More...
 
int getTargetLodLevel () const
 
TexturePtr getTerrainNormalMap () const
 Get the (global) normal map texture. More...
 
void getTerrainPosition (const Vector3 &WSpos, Vector3 *outTSpos) const
 Convert a position from world space to terrain basis space. More...
 
void getTerrainPosition (Real x, Real y, Real z, Vector3 *outTSpos) const
 
void getTerrainPositionAlign (const Vector3 &WSpos, Alignment align, Vector3 *outTSpos) const
 Convert a position from world space to terrain basis space based on a specified alignment. More...
 
void getTerrainPositionAlign (Real x, Real y, Real z, Alignment align, Vector3 *outTSpos) const
 
void getTerrainVector (const Vector3 &inVec, Vector3 *outVec) const
 Translate a vector from world space to local terrain space based on the alignment options. More...
 
void getTerrainVector (Real x, Real y, Real z, Vector3 *outVec) const
 
void getTerrainVectorAlign (const Vector3 &inVec, Alignment align, Vector3 *outVec) const
 Translate a vector from world space to local terrain space based on a specified alignment. More...
 
void getTerrainVectorAlign (Real x, Real y, Real z, Alignment align, Vector3 *outVec) const
 
void getVector (const Vector3 &inVec, Vector3 *outVec) const
 Translate a vector into world space based on the alignment options. More...
 
void getVector (Real x, Real y, Real z, Vector3 *outVec) const
 
void getVectorAlign (const Vector3 &inVec, Alignment align, Vector3 *outVec) const
 Translate a vector into world space based on a specified alignment. More...
 
void getVectorAlign (Real x, Real y, Real z, Alignment align, Vector3 *outVec) const
 
uint32 getVisibilityFlags (void) const
 Get the visibility flags for this terrain. More...
 
AxisAlignedBox getWorldAABB () const
 Get the AABB (world coords) of the entire terrain. More...
 
Real getWorldSize () const
 Get the size of the terrain in world units. More...
 
void handleGenerateMaterialResponse (const WorkQueue::Response *res, const WorkQueue *srcQ)
 Handler for GenerateMaterial. More...
 
WorkQueue::ResponsehandleRequest (const WorkQueue::Request *req, const WorkQueue *srcQ)
 WorkQueue::RequestHandler override. More...
 
void handleResponse (const WorkQueue::Response *res, const WorkQueue *srcQ)
 WorkQueue::ResponseHandler override. More...
 
void increaseLodLevel (bool synchronous=false)
 Increase Terrain's LOD level by 1. More...
 
bool isDerivedDataUpdateInProgress () const
 Query whether a derived data update is in progress or not. More...
 
bool isHeightDataModified () const
 Returns whether terrain heights have been modified since the terrain was first loaded / defined. More...
 
bool isLoaded () const
 Return whether the terrain is loaded. More...
 
bool isModified () const
 Returns whether this terrain has been modified since it was first loaded / defined. More...
 
void load (const String &filename)
 Prepare and load the terrain in one simple call from a standalone file. More...
 
void load (StreamSerialiser &stream)
 Prepare and load the terrain in one simple call from a stream. More...
 
void load (int lodLevel=0, bool synchronous=true)
 Load the terrain based on the data already populated via prepare methods. More...
 
void neighbourModified (NeighbourIndex index, const Rect &edgerect, const Rect &shadowrect)
 Notify that a neighbour has just finished updating and that this change affects this tile. More...
 
void notifyNeighbours ()
 Tell this instance to notify all neighbours that will be affected by a height change that has taken place. More...
 
 OGRE_RW_MUTEX (mNeighbourMutex)
 
virtual void postFindVisibleObjects (SceneManager *source, IlluminationRenderStage irs, Viewport *v)
 Called after searching for visible objects in this SceneManager. More...
 
virtual void postUpdateSceneGraph (SceneManager *source, Camera *camera)
 Called after updating the scene graph in this SceneManager. More...
 
void preFindVisibleObjects (SceneManager *source, SceneManager::IlluminationRenderStage irs, Viewport *v)
 Overridden from SceneManager::Listener. More...
 
bool prepare (const String &filename)
 Prepare the terrain from a standalone file. More...
 
bool prepare (DataStreamPtr &stream)
 Prepare terrain data from saved data. More...
 
bool prepare (StreamSerialiser &stream)
 Prepare terrain data from saved data. More...
 
bool prepare (const ImportData &importData)
 Prepare the terrain from some import data rather than loading from native data. More...
 
virtual void preUpdateSceneGraph (SceneManager *source, Camera *camera)
 Called prior to updating the scene graph in this SceneManager. More...
 
std::pair< bool, Vector3rayIntersects (const Ray &ray, bool cascadeToNeighbours=false, Real distanceLimit=0)
 Test for intersection of a given ray with the terrain. More...
 
TerrainraySelectNeighbour (const Ray &ray, Real distanceLimit=0)
 Utility method to pick a neighbour based on a ray. More...
 
void removeLayer (uint8 index)
 Remove a layer from the terrain. More...
 
void removeQueryFlags (uint32 flags)
 
void replaceLayer (uint8 index, bool keepBlends, Real worldSize=0, const StringVector *textureNames=0)
 Replace an existing terrain layer, optionally preserving all other layer blend maps. More...
 
void save (const String &filename)
 Save terrain data in native form to a standalone file. More...
 
void save (StreamSerialiser &stream)
 Save terrain data in native form to a serializing stream. More...
 
void sceneManagerDestroyed (SceneManager *source)
 Overridden from SceneManager::Listener. More...
 
void setGlobalColourMapEnabled (bool enabled, uint16 size=0)
 Set whether a global colour map is enabled. More...
 
void setGpuBufferAllocator (GpuBufferAllocator *alloc)
 Tell this instance to use the given GpuBufferAllocator. More...
 
void setHeightAtPoint (long x, long y, float h)
 Set the height data for a given terrain point. More...
 
void setLayerTextureName (uint8 layerIndex, uint8 samplerIndex, const String &textureName)
 Set the name of the texture bound to a given index within a given layer. More...
 
void setLayerWorldSize (uint8 index, Real size)
 How large an area in world space the texture in a terrain layer covers before repeating. More...
 
void setNeighbour (NeighbourIndex index, Terrain *neighbour, bool recalculate=false, bool notifyOther=true)
 Set a terrain's neighbour, or null to detach one. More...
 
void setPosition (const Vector3 &pos)
 Set the position of the terrain centre in world coordinates. More...
 
void setQueryFlags (uint32 flags)
 Set the query flags for this terrain. More...
 
void setRenderQueueGroup (uint8 grp)
 Set the render queue group that this terrain will be rendered into. More...
 
void setResourceGroup (const String &resGroup)
 Set the resource group to use when loading / saving. More...
 
void setSize (uint16 newSize)
 Set the size of terrain in vertices along one side. More...
 
void setVisibilityFlags (uint32 flags)
 Set the visibility flags for this terrain. More...
 
void setWorldSize (Real newWorldSize)
 Set the world size of terrain. More...
 
virtual void shadowTextureCasterPreViewProj (Light *light, Camera *camera, size_t iteration)
 This event occurs just before the view & projection matrices are set for rendering into a shadow texture. More...
 
virtual void shadowTextureReceiverPreViewProj (Light *light, Frustum *frustum)
 This event occurs just before the view & projection matrices are set for re-rendering a shadow receiver. More...
 
virtual void shadowTexturesUpdated (size_t numberOfShadowTextures)
 Event raised after all shadow textures have been rendered into for all queues / targets but before any other geometry has been rendered (including main scene geometry and any additional shadow receiver passes). More...
 
virtual bool sortLightsAffectingFrustum (LightList &lightList)
 Hook to allow the listener to override the ordering of lights for the entire frustum. More...
 
void unload ()
 Unload the terrain and free GPU resources. More...
 
void unprepare ()
 Free CPU resources created during prepare methods. More...
 
void update (bool synchronous=false)
 Trigger the update process for the terrain. More...
 
void updateCompositeMap ()
 Performs an update on the terrain composite map based on its dirty region. More...
 
void updateCompositeMapWithDelay (Real delay=2)
 Performs an update on the terrain composite map based on its dirty region, but only at a maximum frequency. More...
 
void updateDerivedData (bool synchronous=false, uint8 typeMask=0xFF)
 Updates derived data for the terrain (LOD, lighting) to reflect changed height data, in a separate thread if threading is enabled (OGRE_THREAD_SUPPORT). More...
 
void updateGeometry ()
 Performs an update on the terrain geometry based on the dirty region. More...
 
void updateGeometryWithoutNotifyNeighbours ()
 Performs an update on the terrain geometry based on the dirty region. More...
 
void widenRectByVector (const Vector3 &vec, const Rect &inRect, Rect &outRect)
 Widen a rectangular area of terrain to take into account an extrusion vector. More...
 
void widenRectByVector (const Vector3 &vec, const Rect &inRect, Real minHeight, Real maxHeight, Rect &outRect)
 Widen a rectangular area of terrain to take into account an extrusion vector, but specify the min / max heights to extrude manually. More...
 

Static Public Member Functions

static uint16 _calcSkirtVertexIndex (uint16 mainIndex, uint16 vdatasize, bool isCol, uint16 numSkirtRowsCols, uint16 skirtRowColSkip)
 Utility method to calculate the skirt index for a given original vertex index. More...
 
static size_t _getNumIndexesForBatchSize (uint16 batchSize)
 Utility method to get the number of indexes required to render a given batch. More...
 
static void _populateIndexBuffer (uint16 *pIndexes, uint16 batchSize, uint16 vdatasize, uint16 vertexIncrement, uint16 xoffset, uint16 yoffset, uint16 numSkirtRowsCols, uint16 skirtRowColSkip)
 Utility method to populate a (locked) index buffer. More...
 
static void convertTerrainToWorldAxes (Alignment align, const Vector3 &terrainVec, Vector3 *worldVec)
 Utility method to convert axes from terrain space (xy terrain, z up) tp world space. More...
 
static void convertWorldToTerrainAxes (Alignment align, const Vector3 &worldVec, Vector3 *terrainVec)
 Utility method to convert axes from world space to terrain space (xy terrain, z up) More...
 
static NeighbourIndex getNeighbourIndex (long offsetx, long offsety)
 Get the neighbour enum for a given offset in a grid (signed). More...
 
static NeighbourIndex getOppositeNeighbour (NeighbourIndex index)
 Get the opposite neighbour relationship (useful for finding the neighbour index from the perspective of the tile the other side of the boundary). More...
 
static bool readLayerDeclaration (StreamSerialiser &ser, TerrainLayerDeclaration &targetdecl)
 Utility method to read a layer declaration from a stream. More...
 
static bool readLayerInstanceList (StreamSerialiser &ser, size_t numSamplers, Terrain::LayerInstanceList &targetlst)
 Utility method to read a layer instance list from a stream. More...
 
static void writeLayerDeclaration (const TerrainLayerDeclaration &decl, StreamSerialiser &ser)
 Utility method to write a layer declaration to a stream. More...
 
static void writeLayerInstanceList (const Terrain::LayerInstanceList &lst, StreamSerialiser &ser)
 Utility method to write a layer instance list to a stream. More...
 

Static Public Attributes

static const uint8 DERIVED_DATA_ALL
 
static const uint8 DERIVED_DATA_DELTAS
 
static const uint8 DERIVED_DATA_LIGHTMAP
 
static const uint8 DERIVED_DATA_NORMALS
 
static const size_t LOD_MORPH_CUSTOM_PARAM
 
static const uint32 TERRAIN_CHUNK_ID
 
static const uint16 TERRAIN_CHUNK_VERSION
 
static const uint64 TERRAIN_GENERATE_MATERIAL_INTERVAL_MS
 
static const uint16 TERRAIN_MAX_BATCH_SIZE
 
static const uint32 TERRAINDERIVEDDATA_CHUNK_ID
 
static const uint16 TERRAINDERIVEDDATA_CHUNK_VERSION
 
static const uint32 TERRAINGENERALINFO_CHUNK_ID
 
static const uint16 TERRAINGENERALINFO_CHUNK_VERSION
 
static const uint32 TERRAINLAYERDECLARATION_CHUNK_ID
 
static const uint16 TERRAINLAYERDECLARATION_CHUNK_VERSION
 
static const uint32 TERRAINLAYERINSTANCE_CHUNK_ID
 
static const uint16 TERRAINLAYERINSTANCE_CHUNK_VERSION
 
static const uint32 TERRAINLAYERSAMPLER_CHUNK_ID
 
static const uint16 TERRAINLAYERSAMPLER_CHUNK_VERSION
 
static const uint32 TERRAINLAYERSAMPLERELEMENT_CHUNK_ID
 
static const uint16 TERRAINLAYERSAMPLERELEMENT_CHUNK_VERSION
 
static const uint16 WORKQUEUE_DERIVED_DATA_REQUEST
 
static const uint16 WORKQUEUE_GENERATE_MATERIAL_REQUEST
 

Friends

class TerrainLodManager
 

Detailed Description

The main containing class for a chunk of terrain.

Terrain can be edited and stored. The data format for this in a file is:
TerrainData (Identifier 'TERR')
[Version 1]
Name Type Description
Terrain orientation uint8 The orientation of the terrain; XZ = 0, XY = 1, YZ = 2
Terrain size uint16 The number of vertices along one side of the terrain
Terrain world size Real The world size of one side of the terrain
Max batch size uint16 The maximum batch size in vertices along one side
Min batch size uint16 The minimum batch size in vertices along one side
Position Vector3 The location of the centre of the terrain
Height data float[size*size] List of floating point heights
LayerDeclaration LayerDeclaration* The layer declaration for this terrain (see below)
Layer count uint8 The number of layers in this terrain
LayerInstance list LayerInstance* A number of LayerInstance definitions based on layer count (see below)
Layer blend map size uint16 The size of the layer blend maps as stored in this file
Packed blend texture data uint8* layerCount-1 sets of blend texture data interleaved as either RGB or RGBA depending on layer count
Optional derived map data TerrainDerivedMap list 0 or more sets of map data derived from the original terrain
Delta data float[size*size] At each vertex, delta information for the LOD at which this vertex disappears
Quadtree delta data float[quadtrees*lods] At each quadtree node, for each lod a record of the max delta value in the region
TerrainLayerDeclaration (Identifier 'TDCL')
[Version 1]
Name Type Description
TerrainLayerSampler Count uint8 Number of samplers in this declaration
TerrainLayerSampler List TerrainLayerSampler* List of TerrainLayerSampler structures
Sampler Element Count uint8 Number of sampler elements in this declaration
TerrainLayerSamplerElement List TerrainLayerSamplerElement* List of TerrainLayerSamplerElement structures
TerrainLayerSampler (Identifier 'TSAM')
[Version 1]
Name Type Description
Alias String Alias name of this sampler
Format uint8 Desired pixel format
TerrainLayerSamplerElement (Identifier 'TSEL')
[Version 1]
Name Type Description
Source uint8 Sampler source index
Semantic uint8 Semantic interpretation of this element
Element start uint8 Start of this element in the sampler
Element count uint8 Number of elements in the sampler used by this entry
LayerInstance (Identifier 'TLIN')
[Version 1]
Name Type Description
World size Real The world size of this layer (determines UV scaling)
Texture list String* List of texture names corresponding to the number of samplers in the layer declaration
TerrainDerivedData (Identifier 'TDDA')
[Version 1]
Name Type Description
Derived data type name String Name of the derived data type ('normalmap', 'lightmap', 'colourmap', 'compositemap')
Size uint16 Size of the data along one edge
Data varies based on type The data

Member Typedef Documentation

◆ RealVector

typedef std::vector<Real> Ogre::Terrain::RealVector

◆ LayerInstanceList

Member Enumeration Documentation

◆ Alignment

The alignment of the terrain.

Enumerator
ALIGN_X_Z 

Terrain is in the X/Z plane.

ALIGN_X_Y 

Terrain is in the X/Y plane.

ALIGN_Y_Z 

Terrain is in the Y/Z plane.

◆ NeighbourIndex

Neighbour index enumeration - indexed anticlockwise from East like angles.

Enumerator
NEIGHBOUR_EAST 
NEIGHBOUR_NORTHEAST 
NEIGHBOUR_NORTH 
NEIGHBOUR_NORTHWEST 
NEIGHBOUR_WEST 
NEIGHBOUR_SOUTHWEST 
NEIGHBOUR_SOUTH 
NEIGHBOUR_SOUTHEAST 
NEIGHBOUR_COUNT 

◆ Space

Enumeration of relative spaces that you might want to use to address the terrain.

Enumerator
WORLD_SPACE 

Simple global world space, axes and positions are all in world space.

LOCAL_SPACE 

As world space, but positions are relative to the terrain world position.

TERRAIN_SPACE 

x & y are parametric values on the terrain from 0 to 1, with the origin at the bottom left.

z is the world space height at that point.

POINT_SPACE 

x & y are integer points on the terrain from 0 to size-1, with the origin at the bottom left.

z is the world space height at that point.

Constructor & Destructor Documentation

◆ Terrain()

Ogre::Terrain::Terrain ( SceneManager sm)

Constructor.

Parameters
smThe SceneManager to use.

◆ ~Terrain()

virtual Ogre::Terrain::~Terrain ( )
virtual

Member Function Documentation

◆ getSceneManager()

SceneManager* Ogre::Terrain::getSceneManager ( ) const
inline

◆ setGpuBufferAllocator()

void Ogre::Terrain::setGpuBufferAllocator ( GpuBufferAllocator alloc)

Tell this instance to use the given GpuBufferAllocator.

Remarks
May only be called when the terrain is not loaded.

◆ getGpuBufferAllocator()

GpuBufferAllocator* Ogre::Terrain::getGpuBufferAllocator ( )

Get the current buffer allocator.

◆ _getNumIndexesForBatchSize()

static size_t Ogre::Terrain::_getNumIndexesForBatchSize ( uint16  batchSize)
static

Utility method to get the number of indexes required to render a given batch.

◆ _populateIndexBuffer()

static void Ogre::Terrain::_populateIndexBuffer ( uint16 pIndexes,
uint16  batchSize,
uint16  vdatasize,
uint16  vertexIncrement,
uint16  xoffset,
uint16  yoffset,
uint16  numSkirtRowsCols,
uint16  skirtRowColSkip 
)
static

Utility method to populate a (locked) index buffer.

Parameters
pIndexesPointer to an index buffer to populate
batchSizeThe number of vertices down one side of the batch
vdatasizeThe number of vertices down one side of the vertex data being referenced
vertexIncrementThe number of vertices to increment for each new indexed row / column
xoffsetThe x offset from the start of the vertex data being referenced
yoffsetThe y offset from the start of the vertex data being referenced
numSkirtRowsColsNumber of rows and columns of skirts
skirtRowColSkipThe number of rows / cols to skip in between skirts

◆ _calcSkirtVertexIndex()

static uint16 Ogre::Terrain::_calcSkirtVertexIndex ( uint16  mainIndex,
uint16  vdatasize,
bool  isCol,
uint16  numSkirtRowsCols,
uint16  skirtRowColSkip 
)
static

Utility method to calculate the skirt index for a given original vertex index.

◆ convertPosition() [1/2]

void Ogre::Terrain::convertPosition ( Space  inSpace,
const Vector3 inPos,
Space  outSpace,
Vector3 outPos 
) const

Convert a position from one space to another with respect to this terrain.

Parameters
inSpaceThe space that inPos is expressed as
inPosThe incoming position
outSpaceThe space which outPos should be expressed as
outPosThe output position to be populated

◆ convertPosition() [2/2]

Vector3 Ogre::Terrain::convertPosition ( Space  inSpace,
const Vector3 inPos,
Space  outSpace 
) const

Convert a position from one space to another with respect to this terrain.

Parameters
inSpaceThe space that inPos is expressed as
inPosThe incoming position
outSpaceThe space which outPos should be expressed as
Returns
The output position

◆ convertDirection() [1/2]

void Ogre::Terrain::convertDirection ( Space  inSpace,
const Vector3 inDir,
Space  outSpace,
Vector3 outDir 
) const

Convert a direction from one space to another with respect to this terrain.

Parameters
inSpaceThe space that inDir is expressed as
inDirThe incoming direction
outSpaceThe space which outDir should be expressed as
outDirThe output direction to be populated

◆ convertDirection() [2/2]

Vector3 Ogre::Terrain::convertDirection ( Space  inSpace,
const Vector3 inDir,
Space  outSpace 
) const

Convert a direction from one space to another with respect to this terrain.

Parameters
inSpaceThe space that inDir is expressed as
inDirThe incoming direction
outSpaceThe space which outDir should be expressed as
Returns
The output direction

◆ setResourceGroup()

void Ogre::Terrain::setResourceGroup ( const String resGroup)
inline

Set the resource group to use when loading / saving.

Parameters
resGroupResource group name - you can set this to blank to use the default in TerrainGlobalOptions.

◆ getResourceGroup()

const String& Ogre::Terrain::getResourceGroup ( void  ) const
inline

Get the resource group to use when loading / saving.

If this is blank, the default in TerrainGlobalOptions will be used.

◆ _getDerivedResourceGroup()

const String& Ogre::Terrain::_getDerivedResourceGroup ( ) const

Get the final resource group to use when loading / saving.

◆ save() [1/2]

void Ogre::Terrain::save ( const String filename)

Save terrain data in native form to a standalone file.

Parameters
filenameThe name of the file to save to. If this is a filename with no path elements, then it is saved in the first writeable location available in the resource group you have chosen to use for this terrain. If the filename includes path specifiers then it is saved directly instead (but note that it may not be reloadable via the resource system if the location is not on the path).

◆ save() [2/2]

void Ogre::Terrain::save ( StreamSerialiser stream)

Save terrain data in native form to a serializing stream.

Remarks
If you want complete control over where the terrain data goes, use this form.

◆ prepare() [1/4]

bool Ogre::Terrain::prepare ( const String filename)

Prepare the terrain from a standalone file.

Note
This is safe to do in a background thread as it creates no GPU resources. It reads data from a native terrain data chunk. For more advanced uses, such as loading from a shared file, use the StreamSerialiser form.

◆ prepare() [2/4]

bool Ogre::Terrain::prepare ( DataStreamPtr stream)

Prepare terrain data from saved data.

Remarks
This is safe to do in a background thread as it creates no GPU resources. It reads data from a native terrain data chunk.
Returns
true if the preparation was successful

◆ prepare() [3/4]

bool Ogre::Terrain::prepare ( StreamSerialiser stream)

Prepare terrain data from saved data.

Remarks
This is safe to do in a background thread as it creates no GPU resources. It reads data from a native terrain data chunk.
Returns
true if the preparation was successful

◆ prepare() [4/4]

bool Ogre::Terrain::prepare ( const ImportData importData)

Prepare the terrain from some import data rather than loading from native data.

Remarks
This method may be called in a background thread.

◆ load() [1/3]

void Ogre::Terrain::load ( const String filename)

Prepare and load the terrain in one simple call from a standalone file.

Note
This method must be called from the primary render thread. To load data in a background thread, use the prepare() method.

◆ load() [2/3]

void Ogre::Terrain::load ( StreamSerialiser stream)

Prepare and load the terrain in one simple call from a stream.

Note
This method must be called from the primary render thread. To load data in a background thread, use the prepare() method.

◆ load() [3/3]

void Ogre::Terrain::load ( int  lodLevel = 0,
bool  synchronous = true 
)

Load the terrain based on the data already populated via prepare methods.

Remarks
This method must be called in the main render thread.
Parameters
lodLevelLoad the specified LOD level
synchronousLoad type

◆ isLoaded()

bool Ogre::Terrain::isLoaded ( void  ) const
inline

Return whether the terrain is loaded.

Remarks
Should only be called from the render thread really, since this is where the loaded state changes.

◆ isModified()

bool Ogre::Terrain::isModified ( ) const
inline

Returns whether this terrain has been modified since it was first loaded / defined.

Remarks
This flag is reset on save().

◆ isHeightDataModified()

bool Ogre::Terrain::isHeightDataModified ( ) const
inline

Returns whether terrain heights have been modified since the terrain was first loaded / defined.

Remarks
This flag is reset on save().

◆ unload()

void Ogre::Terrain::unload ( )

Unload the terrain and free GPU resources.

Remarks
This method must be called in the main render thread.

◆ unprepare()

void Ogre::Terrain::unprepare ( )

Free CPU resources created during prepare methods.

Remarks
This is safe to do in a background thread after calling unload().

◆ getHeightData() [1/2]

float* Ogre::Terrain::getHeightData ( ) const

Get a pointer to all the height data for this terrain.

Remarks
The height data is in world coordinates, relative to the position of the terrain.
This pointer is not const, so you can update the height data if you wish. However, changes will not be propagated until you call Terrain::dirty or Terrain::dirtyRect.

◆ getHeightData() [2/2]

float* Ogre::Terrain::getHeightData ( long  x,
long  y 
) const

Get a pointer to the height data for a given point.

◆ getHeightAtPoint()

float Ogre::Terrain::getHeightAtPoint ( long  x,
long  y 
) const

Get the height data for a given terrain point.

Parameters
x,yDiscrete coordinates in terrain vertices, values from 0 to size-1, left/right bottom/top

◆ setHeightAtPoint()

void Ogre::Terrain::setHeightAtPoint ( long  x,
long  y,
float  h 
)

Set the height data for a given terrain point.

Note
this doesn't take effect until you call update()
Parameters
x,yDiscrete coordinates in terrain vertices, values from 0 to size-1, left/right bottom/top
hThe new height

◆ getHeightAtTerrainPosition()

float Ogre::Terrain::getHeightAtTerrainPosition ( Real  x,
Real  y 
) const

Get the height data for a given terrain position.

Parameters
x,yPosition in terrain space, values from 0 to 1 left/right bottom/top

◆ getHeightAtWorldPosition() [1/2]

float Ogre::Terrain::getHeightAtWorldPosition ( Real  x,
Real  y,
Real  z 
) const

Get the height data for a given world position (projecting the point down on to the terrain).

Parameters
x,y,zPosition in world space. Positions will be clamped to the edge of the terrain

◆ getHeightAtWorldPosition() [2/2]

float Ogre::Terrain::getHeightAtWorldPosition ( const Vector3 pos) const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ getDeltaData() [1/2]

const float* Ogre::Terrain::getDeltaData ( ) const

Get a pointer to all the delta data for this terrain.

Remarks
The delta data is a measure at a given vertex of by how much vertically a vertex will have to move to reach the point at which it will be removed in the next lower LOD.

◆ getDeltaData() [2/2]

const float* Ogre::Terrain::getDeltaData ( long  x,
long  y 
) const

Get a pointer to the delta data for a given point.

◆ getPoint() [1/2]

void Ogre::Terrain::getPoint ( long  x,
long  y,
Vector3 outpos 
) const

Get a Vector3 of the world-space point on the terrain, aligned as per options.

Note
This point is relative to Terrain::getPosition

◆ getPointFromSelfOrNeighbour()

void Ogre::Terrain::getPointFromSelfOrNeighbour ( long  x,
long  y,
Vector3 outpos 
) const

Get a Vector3 of the world-space point on the terrain, aligned as per options.

Cascades into neighbours if out of bounds.

Note
This point is relative to Terrain::getPosition - neighbours are adjusted to be relative to this tile

◆ getPoint() [2/2]

void Ogre::Terrain::getPoint ( long  x,
long  y,
float  height,
Vector3 outpos 
) const

Get a Vector3 of the world-space point on the terrain, supplying the height data manually (can be more optimal).

Note
This point is relative to Terrain::getPosition

◆ getPointTransform()

void Ogre::Terrain::getPointTransform ( Matrix4 outXform) const

Get a transform which converts Vector4(xindex, yindex, height, 1) into an object-space position including scalings and alignment.

◆ getTerrainVector() [1/2]

void Ogre::Terrain::getTerrainVector ( const Vector3 inVec,
Vector3 outVec 
) const

Translate a vector from world space to local terrain space based on the alignment options.

Parameters
inVecThe vector in basis space, where x/y represents the terrain plane and z represents the up vector
[out]outVec

◆ getTerrainVector() [2/2]

void Ogre::Terrain::getTerrainVector ( Real  x,
Real  y,
Real  z,
Vector3 outVec 
) const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ getTerrainVectorAlign() [1/2]

void Ogre::Terrain::getTerrainVectorAlign ( const Vector3 inVec,
Alignment  align,
Vector3 outVec 
) const

Translate a vector from world space to local terrain space based on a specified alignment.

Parameters
inVecThe vector in basis space, where x/y represents the terrain plane and z represents the up vector
[out]outVec
alignThe alignment of the terrain

◆ getTerrainVectorAlign() [2/2]

void Ogre::Terrain::getTerrainVectorAlign ( Real  x,
Real  y,
Real  z,
Alignment  align,
Vector3 outVec 
) const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ getVector() [1/2]

void Ogre::Terrain::getVector ( const Vector3 inVec,
Vector3 outVec 
) const

Translate a vector into world space based on the alignment options.

Parameters
inVecThe vector in basis space, where x/y represents the terrain plane and z represents the up vector
[out]outVec

◆ getVector() [2/2]

void Ogre::Terrain::getVector ( Real  x,
Real  y,
Real  z,
Vector3 outVec 
) const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ getVectorAlign() [1/2]

void Ogre::Terrain::getVectorAlign ( const Vector3 inVec,
Alignment  align,
Vector3 outVec 
) const

Translate a vector into world space based on a specified alignment.

Parameters
inVecThe vector in basis space, where x/y represents the terrain plane and z represents the up vector
[out]outVec
alignThe alignment of the terrain

◆ getVectorAlign() [2/2]

void Ogre::Terrain::getVectorAlign ( Real  x,
Real  y,
Real  z,
Alignment  align,
Vector3 outVec 
) const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ getPosition() [1/3]

void Ogre::Terrain::getPosition ( const Vector3 TSpos,
Vector3 outWSpos 
) const

Convert a position from terrain basis space to world space.

Parameters
TSposTerrain space position, where (0,0) is the bottom-left of the terrain, and (1,1) is the top-right. The Z coordinate is in absolute height units.
Note
This position is relative to Terrain::getPosition
Parameters
outWSposWorld space output position (setup according to current alignment).

◆ getPosition() [2/3]

void Ogre::Terrain::getPosition ( Real  x,
Real  y,
Real  z,
Vector3 outWSpos 
) const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ getTerrainPosition() [1/2]

void Ogre::Terrain::getTerrainPosition ( const Vector3 WSpos,
Vector3 outTSpos 
) const

Convert a position from world space to terrain basis space.

Parameters
WSposWorld space position (setup according to current alignment).
outTSposTerrain space output position, where (0,0) is the bottom-left of the terrain, and (1,1) is the top-right. The Z coordinate is in absolute height units.

◆ getTerrainPosition() [2/2]

void Ogre::Terrain::getTerrainPosition ( Real  x,
Real  y,
Real  z,
Vector3 outTSpos 
) const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ getPositionAlign() [1/2]

void Ogre::Terrain::getPositionAlign ( const Vector3 TSpos,
Alignment  align,
Vector3 outWSpos 
) const

Convert a position from terrain basis space to world space based on a specified alignment.

Parameters
TSposTerrain space position, where (0,0) is the bottom-left of the terrain, and (1,1) is the top-right. The Z coordinate is in absolute height units.
outWSposWorld space output position (setup according to alignment).
alignThe alignment of the terrain

◆ getPositionAlign() [2/2]

void Ogre::Terrain::getPositionAlign ( Real  x,
Real  y,
Real  z,
Alignment  align,
Vector3 outWSpos 
) const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ getTerrainPositionAlign() [1/2]

void Ogre::Terrain::getTerrainPositionAlign ( const Vector3 WSpos,
Alignment  align,
Vector3 outTSpos 
) const

Convert a position from world space to terrain basis space based on a specified alignment.

Parameters
WSposWorld space position (setup according to alignment).
outTSposTerrain space output position, where (0,0) is the bottom-left of the terrain, and (1,1) is the top-right. The Z coordinate is in absolute height units.
alignThe alignment of the terrain

◆ getTerrainPositionAlign() [2/2]

void Ogre::Terrain::getTerrainPositionAlign ( Real  x,
Real  y,
Real  z,
Alignment  align,
Vector3 outTSpos 
) const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ getAlignment()

Alignment Ogre::Terrain::getAlignment ( ) const

Get the alignment of the terrain.

◆ getSize()

uint16 Ogre::Terrain::getSize ( ) const

Get the size of the terrain in vertices along one side.

◆ setSize()

void Ogre::Terrain::setSize ( uint16  newSize)

Set the size of terrain in vertices along one side.

Note
The existing height data will be bilinear filtered to fill the new size
Parameters
newSizethe new size of the terrain

◆ getMaxBatchSize()

uint16 Ogre::Terrain::getMaxBatchSize ( ) const

Get the maximum size in vertices along one side of a batch.

◆ getMinBatchSize()

uint16 Ogre::Terrain::getMinBatchSize ( ) const

Get the minimum size in vertices along one side of a batch.

◆ getWorldSize()

Real Ogre::Terrain::getWorldSize ( ) const

Get the size of the terrain in world units.

◆ setWorldSize()

void Ogre::Terrain::setWorldSize ( Real  newWorldSize)

Set the world size of terrain.

Parameters
newWorldSizethe new world size of the terrain

◆ getLayerCount()

uint8 Ogre::Terrain::getLayerCount ( ) const
inline

Get the number of layers in this terrain.

◆ getLayerDeclaration()

const TerrainLayerDeclaration& Ogre::Terrain::getLayerDeclaration ( ) const
inline

Get the declaration which describes the layers in this terrain.

◆ addLayer() [1/2]

void Ogre::Terrain::addLayer ( Real  worldSize = 0,
const StringVector textureNames = 0 
)

Add a new layer to this terrain.

Parameters
worldSizeThe size of the texture in this layer in world units. Default to zero to use the default
textureNamesA list of textures to assign to the samplers in this layer. Leave blank to provide these later.

◆ addLayer() [2/2]

void Ogre::Terrain::addLayer ( uint8  index,
Real  worldSize = 0,
const StringVector textureNames = 0 
)

Add a new layer to this terrain at a specific index.

Parameters
indexThe index at which to insert this layer (existing layers are shifted forwards)
worldSizeThe size of the texture in this layer in world units. Default to zero to use the default
textureNamesA list of textures to assign to the samplers in this layer. Leave blank to provide these later.

◆ removeLayer()

void Ogre::Terrain::removeLayer ( uint8  index)

Remove a layer from the terrain.

◆ replaceLayer()

void Ogre::Terrain::replaceLayer ( uint8  index,
bool  keepBlends,
Real  worldSize = 0,
const StringVector textureNames = 0 
)

Replace an existing terrain layer, optionally preserving all other layer blend maps.

Parameters
indexThe 0 based index of the terrain layer to replace
keepBlendsTrue to keep using the existing blend maps. False to reset the blend map for the layer. Irrelevant if index == 0
worldSizeThe size of the texture in this layer in world units. Default to zero to use the default
textureNamesA list of textures to assign to the samplers in this layer. Leave blank to provide these later.

◆ getMaxLayers()

uint8 Ogre::Terrain::getMaxLayers ( ) const

Get the maximum number of layers supported with the current options.

Note
When you change the options requested, this value can change.

◆ getLayerWorldSize()

Real Ogre::Terrain::getLayerWorldSize ( uint8  index) const

How large an area in world space the texture in a terrain layer covers before repeating.

Parameters
indexThe layer index.

◆ setLayerWorldSize()

void Ogre::Terrain::setLayerWorldSize ( uint8  index,
Real  size 
)

How large an area in world space the texture in a terrain layer covers before repeating.

Parameters
indexThe layer index.
sizeThe world size of the texture before repeating

◆ getLayerUVMultiplier()

Real Ogre::Terrain::getLayerUVMultiplier ( uint8  index) const

Get the layer UV multiplier.

Remarks
This is derived from the texture world size. The base UVs in the terrain vary from 0 to 1 and this multiplier is used (in a fixed-function texture coord scaling or a shader parameter) to translate it to the final value.
Parameters
indexThe layer index.

◆ getLayerTextureName()

const String& Ogre::Terrain::getLayerTextureName ( uint8  layerIndex,
uint8  samplerIndex 
) const

Get the name of the texture bound to a given index within a given layer.

See the LayerDeclaration for a list of sampelrs within a layer.

Parameters
layerIndexThe layer index.
samplerIndexThe sampler index within a layer

◆ setLayerTextureName()

void Ogre::Terrain::setLayerTextureName ( uint8  layerIndex,
uint8  samplerIndex,
const String textureName 
)

Set the name of the texture bound to a given index within a given layer.

See the LayerDeclaration for a list of sampelrs within a layer.

Parameters
layerIndexThe layer index.
samplerIndexThe sampler index within a layer
textureNameThe name of the texture to use

◆ getLayerBlendMapSize()

uint16 Ogre::Terrain::getLayerBlendMapSize ( ) const
inline

Get the requested size of the blend maps used to blend between layers for this terrain.

Note that where hardware limits this, the actual blend maps may be lower resolution. This option is derived from TerrainGlobalOptions when the terrain is created.

◆ getLightmapSize()

uint16 Ogre::Terrain::getLightmapSize ( ) const
inline

Get the requested size of lightmap for this terrain.

Note that where hardware limits this, the actual lightmap may be lower resolution. This option is derived from TerrainGlobalOptions when the terrain is created.

◆ getLightmap()

const TexturePtr& Ogre::Terrain::getLightmap ( ) const
inline

Get access to the lightmap, if enabled (as requested by the material generator)

◆ getCompositeMapSize()

uint16 Ogre::Terrain::getCompositeMapSize ( ) const
inline

Get the requested size of composite map for this terrain.

Note that where hardware limits this, the actual texture may be lower resolution. This option is derived from TerrainGlobalOptions when the terrain is created.

◆ getCompositeMap()

const TexturePtr& Ogre::Terrain::getCompositeMap ( ) const
inline

Get access to the composite map, if enabled (as requested by the material generator)

◆ getPosition() [3/3]

const Vector3& Ogre::Terrain::getPosition ( ) const
inline

Get the world position of the terrain centre.

◆ setPosition()

void Ogre::Terrain::setPosition ( const Vector3 pos)

Set the position of the terrain centre in world coordinates.

◆ _getRootSceneNode()

SceneNode* Ogre::Terrain::_getRootSceneNode ( ) const

Get the root scene node for the terrain (internal use only)

◆ dirty()

void Ogre::Terrain::dirty ( )

Mark the entire terrain as dirty.

By marking a section of the terrain as dirty, you are stating that you have changed the height data within this rectangle. This rectangle will be merged with any existing outstanding changes. To finalise the changes, you must call update(), updateGeometry(), or updateDerivedData().

◆ dirtyRect()

void Ogre::Terrain::dirtyRect ( const Rect rect)

Mark a region of the terrain as dirty.

By marking a section of the terrain as dirty, you are stating that you have changed the height data within this rectangle. This rectangle will be merged with any existing outstanding changes. To finalise the changes, you must call update(), updateGeometry(), or updateDerivedData().

Parameters
rectA rectangle expressed in vertices describing the dirty region; left < right, top < bottom, left & top are inclusive, right & bottom exclusive

◆ _dirtyCompositeMapRect()

void Ogre::Terrain::_dirtyCompositeMapRect ( const Rect rect)

Mark a region of the terrain composite map as dirty.

Remarks
You don't usually need to call this directly, it is inferred from changing the other data on the terrain.

◆ dirtyLightmapRect()

void Ogre::Terrain::dirtyLightmapRect ( const Rect rect)

Mark a region of the lightmap as dirty.

Remarks
You only need to call this if you need to tell the terrain to update the lightmap data for some reason other than the terrain geometry has changed. Changing terrain geometry automatically dirties the correct lightmap areas.
Note
The lightmap won't actually be updated until update() or updateDerivedData() is called.

◆ dirtyLightmap()

void Ogre::Terrain::dirtyLightmap ( )

Mark a the entire lightmap as dirty.

Remarks
You only need to call this if you need to tell the terrain to update the lightmap data for some reason other than the terrain geometry has changed. Changing terrain geometry automatically dirties the correct lightmap areas.
Note
The lightmap won't actually be updated until update() or updateDerivedData() is called.

◆ update()

void Ogre::Terrain::update ( bool  synchronous = false)

Trigger the update process for the terrain.

Remarks
Updating the terrain will process any dirty sections of the terrain. This may affect many things:
  1. The terrain geometry
  2. The terrain error metrics which determine LOD transitions
  3. The terrain normal map, if present
  4. The terrain lighting map, if present
  5. The terrain composite map, if present
If threading is enabled, only item 1 (the geometry) will be updated synchronously, ie will be fully up to date when this method returns. The other elements are more expensive to compute, and will be queued for processing in a background thread, in the order shown above. As these updates complete, the effects will be shown.

You can also separate the timing of updating the geometry, LOD and the lighting information if you want, by calling updateGeometry() and updateDerivedData() separately.

Parameters
synchronousIf true, all updates will happen immediately and not in a separate thread.

◆ updateGeometry()

void Ogre::Terrain::updateGeometry ( )

Performs an update on the terrain geometry based on the dirty region.

Remarks
Terrain geometry will be updated when this method returns.

◆ updateGeometryWithoutNotifyNeighbours()

void Ogre::Terrain::updateGeometryWithoutNotifyNeighbours ( )

Performs an update on the terrain geometry based on the dirty region.

Remarks
Terrain geometry will be updated when this method returns, and no neighbours will be notified.

◆ updateDerivedData()

void Ogre::Terrain::updateDerivedData ( bool  synchronous = false,
uint8  typeMask = 0xFF 
)

Updates derived data for the terrain (LOD, lighting) to reflect changed height data, in a separate thread if threading is enabled (OGRE_THREAD_SUPPORT).

If threading is enabled, on return from this method the derived data will not necessarily be updated immediately, the calculation may be done in the background. Only one update will run in the background at once. This derived data can typically survive being out of sync for a few frames which is why it is not done synchronously

Parameters
synchronousIf true, the update will happen immediately and not in a separate thread.
typeMaskMask indicating the types of data we should generate

◆ updateCompositeMap()

void Ogre::Terrain::updateCompositeMap ( )

Performs an update on the terrain composite map based on its dirty region.

Remarks
Rather than calling this directly, call updateDerivedData, which will also call it after the other derived data has been updated (there is no point updating the composite map until lighting has been updated). However the blend maps may call this directly when only the blending information has been updated.

◆ updateCompositeMapWithDelay()

void Ogre::Terrain::updateCompositeMapWithDelay ( Real  delay = 2)

Performs an update on the terrain composite map based on its dirty region, but only at a maximum frequency.

Remarks
Rather than calling this directly, call updateDerivedData, which will also call it after the other derived data has been updated (there is no point updating the composite map until lighting has been updated). However the blend maps may call this directly when only the blending information has been updated.
Note
This method will log the request for an update, but won't do it just yet unless there are no further requests in the next 'delay' seconds. This means you can call it all the time but only pick up changes in quiet times.

◆ getSkirtSize()

Real Ogre::Terrain::getSkirtSize ( ) const
inline

The default size of 'skirts' used to hide terrain cracks (default 10, set for new Terrain using TerrainGlobalOptions)

◆ getNumLodLevels()

uint16 Ogre::Terrain::getNumLodLevels ( void  ) const
inline

Get the total number of LOD levels in the terrain.

◆ getNumLodLevelsPerLeaf()

uint16 Ogre::Terrain::getNumLodLevelsPerLeaf ( ) const
inline

Get the number of LOD levels in a leaf of the terrain quadtree.

◆ calculateHeightDeltas()

Rect Ogre::Terrain::calculateHeightDeltas ( const Rect rect)

Calculate (or recalculate) the delta values of heights between a vertex in its recorded position, and the place it will end up in the LOD in which it is removed.

Parameters
rectRectangle describing the area in which heights have altered
Returns
A Rectangle describing the area which was updated (may be wider than the input rectangle)

◆ finaliseHeightDeltas()

void Ogre::Terrain::finaliseHeightDeltas ( const Rect rect,
bool  cpuData 
)

Finalise the height deltas.

Calculated height deltas are kept in a separate calculation field to make them safe to perform in a background thread. This call promotes those calculations to the runtime values, and must be called in the main thread.

Parameters
rectRectangle describing the area to finalise
cpuDataWhen updating vertex data, update the CPU copy (background)

◆ calculateNormals()

PixelBox* Ogre::Terrain::calculateNormals ( const Rect rect,
Rect outFinalRect 
)

Calculate (or recalculate) the normals on the terrain.

Parameters
rectRectangle describing the area of heights that were changed
outFinalRectOutput rectangle describing the area updated
Returns
Pointer to a PixelBox full of normals (caller responsible for deletion)

◆ finaliseNormals()

void Ogre::Terrain::finaliseNormals ( const Rect rect,
PixelBox normalsBox 
)

Finalise the normals.

Calculated normals are kept in a separate calculation area to make them safe to perform in a background thread. This call promotes those calculations to the runtime values, and must be called in the main thread.

Parameters
rectRectangle describing the area to finalise
normalsBoxPointer to a PixelBox full of normals

◆ calculateLightmap()

PixelBox* Ogre::Terrain::calculateLightmap ( const Rect rect,
const Rect extraTargetRect,
Rect outFinalRect 
)

Calculate (or recalculate) the terrain lightmap.

Parameters
rectRectangle describing the area of heights that were changed
extraTargetRectRectangle describing a target area of the terrain that needs to be calculated additionally (e.g. from a neighbour)
outFinalRectOutput rectangle describing the area updated in the lightmap
Returns
Pointer to a PixelBox full of lighting data (caller responsible for deletion)

◆ finaliseLightmap()

void Ogre::Terrain::finaliseLightmap ( const Rect rect,
PixelBox lightmapBox 
)

Finalise the lightmap.

Calculating lightmaps is kept in a separate calculation area to make it safe to perform in a background thread. This call promotes those calculations to the runtime values, and must be called in the main thread.

Parameters
rectRectangle describing the area to finalise
lightmapBoxPointer to a PixelBox full of normals

◆ getResolutionAtLod()

uint16 Ogre::Terrain::getResolutionAtLod ( uint16  lodLevel) const

Gets the resolution of the entire terrain (down one edge) at a given LOD level.

◆ rayIntersects()

std::pair<bool, Vector3> Ogre::Terrain::rayIntersects ( const Ray ray,
bool  cascadeToNeighbours = false,
Real  distanceLimit = 0 
)

Test for intersection of a given ray with the terrain.

If the ray hits the terrain, the point of intersection is returned.

Parameters
rayThe ray to test for intersection
cascadeToNeighboursWhether the ray will be projected onto neighbours if no intersection is found
distanceLimitThe distance from the ray origin at which we will stop looking, 0 indicates no limit
Returns
A pair which contains whether the ray hit the terrain and, if so, where.
Remarks
This can be called from any thread as long as no parallel write to the heightmap data occurs.

◆ getAABB()

const AxisAlignedBox& Ogre::Terrain::getAABB ( ) const

Get the AABB (local coords) of the entire terrain.

◆ getWorldAABB()

AxisAlignedBox Ogre::Terrain::getWorldAABB ( ) const

Get the AABB (world coords) of the entire terrain.

◆ getMinHeight()

Real Ogre::Terrain::getMinHeight ( ) const

Get the minimum height of the terrain.

◆ getMaxHeight()

Real Ogre::Terrain::getMaxHeight ( ) const

Get the maximum height of the terrain.

◆ getBoundingRadius()

Real Ogre::Terrain::getBoundingRadius ( ) const

Get the bounding radius of the entire terrain.

◆ getMaterial()

const MaterialPtr& Ogre::Terrain::getMaterial ( ) const

Get the material being used for the terrain.

◆ _getMaterial()

const MaterialPtr& Ogre::Terrain::_getMaterial ( ) const
inline

Internal getting of material.

◆ getCompositeMapMaterial()

const MaterialPtr& Ogre::Terrain::getCompositeMapMaterial ( ) const

Get the material being used for the terrain composite map.

◆ _getCompositeMapMaterial()

const MaterialPtr& Ogre::Terrain::_getCompositeMapMaterial ( ) const
inline

Internal getting of material for the terrain composite map.

◆ getMaterialName()

const String& Ogre::Terrain::getMaterialName ( ) const
inline

Get the name of the material being used for the terrain.

◆ preFindVisibleObjects()

void Ogre::Terrain::preFindVisibleObjects ( SceneManager source,
SceneManager::IlluminationRenderStage  irs,
Viewport v 
)
virtual

Overridden from SceneManager::Listener.

Reimplemented from Ogre::SceneManager::Listener.

◆ sceneManagerDestroyed()

void Ogre::Terrain::sceneManagerDestroyed ( SceneManager source)
virtual

Overridden from SceneManager::Listener.

Reimplemented from Ogre::SceneManager::Listener.

◆ getRenderQueueGroup()

uint8 Ogre::Terrain::getRenderQueueGroup ( void  ) const
inline

Get the render queue group that this terrain will be rendered into.

◆ setRenderQueueGroup()

void Ogre::Terrain::setRenderQueueGroup ( uint8  grp)
inline

Set the render queue group that this terrain will be rendered into.

Remarks
The default is specified in TerrainGlobalOptions

◆ getVisibilityFlags()

uint32 Ogre::Terrain::getVisibilityFlags ( void  ) const
inline

Get the visibility flags for this terrain.

◆ setVisibilityFlags()

void Ogre::Terrain::setVisibilityFlags ( uint32  flags)
inline

Set the visibility flags for this terrain.

Remarks
The default is specified in TerrainGlobalOptions

◆ getQueryFlags()

uint32 Ogre::Terrain::getQueryFlags ( void  ) const
inline

Get the query flags for this terrain.

◆ setQueryFlags()

void Ogre::Terrain::setQueryFlags ( uint32  flags)
inline

Set the query flags for this terrain.

Remarks
The default is specified in TerrainGlobalOptions

◆ addQueryFlags()

void Ogre::Terrain::addQueryFlags ( uint32  flags)
inline

As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object.

◆ removeQueryFlags()

void Ogre::Terrain::removeQueryFlags ( uint32  flags)
inline

◆ getLayerBlendMap()

TerrainLayerBlendMap* Ogre::Terrain::getLayerBlendMap ( uint8  layerIndex)

Retrieve the layer blending map for a given layer, which may be used to edit the blending information for that layer.

Note
You can only do this after the terrain has been loaded. You may edit the content of the blend layer in another thread, but you may only upload it in the main render thread.
Parameters
layerIndexThe layer index, which should be 1 or higher (since the bottom layer has no blending).
Returns
Pointer to the TerrainLayerBlendMap requested. The caller must not delete this instance, use freeTemporaryResources if you want to save the memory after completing your editing.

◆ getBlendTextureIndex()

uint8 Ogre::Terrain::getBlendTextureIndex ( uint8  layerIndex) const

Get the index of the blend texture that a given layer uses.

Parameters
layerIndexThe layer index, must be >= 1 and less than the number of layers
Returns
The index of the shared blend texture

◆ getBlendTextureCount() [1/2]

uint8 Ogre::Terrain::getBlendTextureCount ( ) const

Get the number of blend textures in use.

◆ getBlendTextureCount() [2/2]

uint8 Ogre::Terrain::getBlendTextureCount ( uint8  numLayers) const

Get the number of blend textures needed for a given number of layers.

◆ getBlendTextureName()

const String& Ogre::Terrain::getBlendTextureName ( uint8  textureIndex) const

Get the name of the packed blend texture at a specific index.

Parameters
textureIndexThis is the blend texture index, not the layer index (multiple layers will share a blend texture)

◆ setGlobalColourMapEnabled()

void Ogre::Terrain::setGlobalColourMapEnabled ( bool  enabled,
uint16  size = 0 
)

Set whether a global colour map is enabled.

Remarks
A global colour map can add variation to your terrain and reduce the perceived tiling effect you might get in areas of continuous lighting and the same texture. The global colour map is only used when the material generator chooses to use it.
Note
You must only call this from the main render thread
Parameters
enabledWhether the global colour map is enabled or not
sizeThe resolution of the colour map. A value of zero means 'no change' and the default is set in TerrainGlobalOptions.

◆ getGlobalColourMapEnabled()

bool Ogre::Terrain::getGlobalColourMapEnabled ( ) const
inline

Get whether a global colour map is enabled on this terrain.

◆ getGlobalColourMapSize()

uint16 Ogre::Terrain::getGlobalColourMapSize ( ) const
inline

Get the size of the global colour map (if used)

◆ getGlobalColourMap()

const TexturePtr& Ogre::Terrain::getGlobalColourMap ( ) const
inline

Get access to the global colour map, if enabled.

◆ widenRectByVector() [1/2]

void Ogre::Terrain::widenRectByVector ( const Vector3 vec,
const Rect inRect,
Rect outRect 
)

Widen a rectangular area of terrain to take into account an extrusion vector.

Parameters
vecA vector in world space
inRectInput rectangle
outRectOutput rectangle

◆ widenRectByVector() [2/2]

void Ogre::Terrain::widenRectByVector ( const Vector3 vec,
const Rect inRect,
Real  minHeight,
Real  maxHeight,
Rect outRect 
)

Widen a rectangular area of terrain to take into account an extrusion vector, but specify the min / max heights to extrude manually.

Parameters
vecA vector in world space
inRectInput rectangle
minHeight,maxHeightThe extents of the height to extrude
outRectOutput rectangle

◆ freeTemporaryResources()

void Ogre::Terrain::freeTemporaryResources ( )

Free as many resources as possible for optimal run-time memory use.

Remarks
This class keeps some temporary storage around in order to make certain actions (such as editing) possible more quickly. Calling this method will cause as many of those resources as possible to be freed. You might want to do this for example when you are finished editing a particular terrain and want to have optimal runtime efficiency.

◆ getLayerBlendTexture()

const TexturePtr& Ogre::Terrain::getLayerBlendTexture ( uint8  index) const

Get a blend texture with a given index.

Parameters
indexThe blend texture index (note: not layer index; derive the texture index from getLayerBlendTextureIndex)

◆ getLayerBlendTextureIndex()

std::pair<uint8,uint8> Ogre::Terrain::getLayerBlendTextureIndex ( uint8  layerIndex) const

Get the texture index and colour channel of the blend information for a given layer.

Parameters
layerIndexThe index of the layer (1 or higher, layer 0 has no blend data)
Returns
A pair in which the first value is the texture index, and the second value is the colour channel (RGBA)

◆ _setMorphRequired()

void Ogre::Terrain::_setMorphRequired ( bool  morph)
inline

Request internal implementation options for the terrain material to use, in this case vertex morphing information.

The TerrainMaterialGenerator should call this method to specify the options it would like to use when creating a material. Not all the data is guaranteed to be up to date on return from this method - for example som maps may be generated in the background. However, on return from this method all the features that are requested will be referenceable by materials, the data may just take a few frames to be fully populated.

Parameters
morphWhether LOD morphing information is required to be calculated

◆ _getMorphRequired()

bool Ogre::Terrain::_getMorphRequired ( ) const
inline

Get whether LOD morphing is needed.

◆ _setNormalMapRequired()

void Ogre::Terrain::_setNormalMapRequired ( bool  normalMap)

Request internal implementation options for the terrain material to use, in this case a terrain-wide normal map.

The TerrainMaterialGenerator should call this method to specify the options it would like to use when creating a material. Not all the data is guaranteed to be up to date on return from this method - for example some maps may be generated in the background. However, on return from this method all the features that are requested will be referenceable by materials, the data may just take a few frames to be fully populated.

Parameters
normalMapWhether a terrain-wide normal map is requested. This is usually mutually exclusive with the lightmap option.

◆ _setLightMapRequired()

void Ogre::Terrain::_setLightMapRequired ( bool  lightMap,
bool  shadowsOnly = false 
)

Request internal implementation options for the terrain material to use, in this case a terrain-wide normal map.

The TerrainMaterialGenerator should call this method to specify the options it would like to use when creating a material. Not all the data is guaranteed to be up to date on return from this method - for example some maps may be generated in the background. However, on return from this method all the features that are requested will be referenceable by materials, the data may just take a few frames to be fully populated.

Parameters
lightMapWhether a terrain-wide lightmap including precalculated lighting is required (light direction in TerrainGlobalOptions)
shadowsOnlyIf true, the lightmap contains only shadows, no directional lighting intensity

◆ _setCompositeMapRequired()

void Ogre::Terrain::_setCompositeMapRequired ( bool  compositeMap)

Request internal implementation options for the terrain material to use, in this case a terrain-wide composite map.

The TerrainMaterialGenerator should call this method to specify the options it would like to use when creating a material. Not all the data is guaranteed to be up to date on return from this method - for example some maps may be generated in the background. However, on return from this method all the features that are requested will be referenceable by materials, the data may just take a few frames to be fully populated.

Parameters
compositeMapWhether a terrain-wide composite map is needed. A composite map is a texture with all of the blending and lighting baked in, such that at distance this texture can be used as an approximation of the multi-layer blended material. It is actually up to the material generator to render this composite map, because obviously precisely what it looks like depends on what the main material looks like. For this reason, the composite map is one piece of derived terrain data that is always calculated in the render thread, and usually on the GPU. It is expected that if this option is requested, the material generator will use it to construct distant LOD techniques.

◆ _getUseVertexCompression()

bool Ogre::Terrain::_getUseVertexCompression ( ) const

Whether we're using vertex compression or not.

◆ canHandleRequest()

bool Ogre::Terrain::canHandleRequest ( const WorkQueue::Request req,
const WorkQueue srcQ 
)
virtual

◆ handleRequest()

WorkQueue::Response* Ogre::Terrain::handleRequest ( const WorkQueue::Request req,
const WorkQueue srcQ 
)
virtual

◆ canHandleResponse()

bool Ogre::Terrain::canHandleResponse ( const WorkQueue::Response res,
const WorkQueue srcQ 
)
virtual

◆ handleResponse()

void Ogre::Terrain::handleResponse ( const WorkQueue::Response res,
const WorkQueue srcQ 
)
virtual

◆ handleGenerateMaterialResponse()

void Ogre::Terrain::handleGenerateMaterialResponse ( const WorkQueue::Response res,
const WorkQueue srcQ 
)

Handler for GenerateMaterial.

◆ getLODLevelWhenVertexEliminated() [1/2]

uint16 Ogre::Terrain::getLODLevelWhenVertexEliminated ( long  x,
long  y 
) const

Utility method, get the first LOD Level at which this vertex is no longer included.

◆ getLODLevelWhenVertexEliminated() [2/2]

uint16 Ogre::Terrain::getLODLevelWhenVertexEliminated ( long  rowOrColulmn) const

Utility method, get the first LOD Level at which this vertex is no longer included.

◆ getQuadTree()

TerrainQuadTreeNode* Ogre::Terrain::getQuadTree ( )
inline

Get the top level of the quad tree which is used to divide up the terrain.

◆ getTerrainNormalMap()

TexturePtr Ogre::Terrain::getTerrainNormalMap ( ) const
inline

Get the (global) normal map texture.

◆ getNeighbour()

Terrain* Ogre::Terrain::getNeighbour ( NeighbourIndex  index) const

Retrieve the terrain's neighbour, or null if not present.

Remarks
Terrains only know about their neighbours if they are notified via setNeighbour. This information is not saved with the terrain since every tile must be able to be independent.
Parameters
indexThe index of the neighbour

◆ setNeighbour()

void Ogre::Terrain::setNeighbour ( NeighbourIndex  index,
Terrain neighbour,
bool  recalculate = false,
bool  notifyOther = true 
)

Set a terrain's neighbour, or null to detach one.

Remarks
This information is not saved with the terrain since every tile must be able to be independent. However if modifications are made to a tile which can affect its neighbours, while connected the changes will be propagated.
Parameters
indexThe index of the neighbour
neighbourThe terrain instance to become the neighbour, or null to reset.
recalculateIf true, this terrain instance will recalculate elements that could be affected by the connection of this tile (e.g. matching heights, calcaulting normals, calculating shadows crossing the boundary). If false, this terrain's state is assumed to be up to date already (e.g. was calculated with this tile present before and the state saved).
notifyOtherWhether the neighbour should also be notified (recommended to leave this at the default so relationships are up to date before background updates are triggered)

◆ getOppositeNeighbour()

static NeighbourIndex Ogre::Terrain::getOppositeNeighbour ( NeighbourIndex  index)
static

Get the opposite neighbour relationship (useful for finding the neighbour index from the perspective of the tile the other side of the boundary).

◆ getNeighbourIndex()

static NeighbourIndex Ogre::Terrain::getNeighbourIndex ( long  offsetx,
long  offsety 
)
static

Get the neighbour enum for a given offset in a grid (signed).

◆ notifyNeighbours()

void Ogre::Terrain::notifyNeighbours ( )

Tell this instance to notify all neighbours that will be affected by a height change that has taken place.

Remarks
This method will determine which neighbours need notification and call their neighbourModified method. It is called automatically by updateGeometry().

◆ neighbourModified()

void Ogre::Terrain::neighbourModified ( NeighbourIndex  index,
const Rect edgerect,
const Rect shadowrect 
)

Notify that a neighbour has just finished updating and that this change affects this tile.

Parameters
indexThe neighbour index (from this tile's perspective)
edgerectThe area at the edge of this tile that needs height / normal recalculation (may be null)
shadowrectThe area on this tile where shadows need recalculating (may be null)

◆ raySelectNeighbour()

Terrain* Ogre::Terrain::raySelectNeighbour ( const Ray ray,
Real  distanceLimit = 0 
)

Utility method to pick a neighbour based on a ray.

Parameters
rayThe ray in world space
distanceLimitLimit beyond which we want to ignore neighbours (0 for infinite)
Returns
The first neighbour along this ray, or null

◆ _dumpTextures()

void Ogre::Terrain::_dumpTextures ( const String prefix,
const String suffix 
)

Dump textures to files.

Remarks
This is a debugging method.

◆ isDerivedDataUpdateInProgress()

bool Ogre::Terrain::isDerivedDataUpdateInProgress ( ) const
inline

Query whether a derived data update is in progress or not.

References _OgreTerrainExport, OGRE_RW_MUTEX, and Ogre::operator<<().

◆ convertWorldToTerrainAxes()

static void Ogre::Terrain::convertWorldToTerrainAxes ( Alignment  align,
const Vector3 worldVec,
Vector3 terrainVec 
)
static

Utility method to convert axes from world space to terrain space (xy terrain, z up)

◆ convertTerrainToWorldAxes()

static void Ogre::Terrain::convertTerrainToWorldAxes ( Alignment  align,
const Vector3 terrainVec,
Vector3 worldVec 
)
static

Utility method to convert axes from terrain space (xy terrain, z up) tp world space.

◆ writeLayerDeclaration()

static void Ogre::Terrain::writeLayerDeclaration ( const TerrainLayerDeclaration decl,
StreamSerialiser ser 
)
static

Utility method to write a layer declaration to a stream.

◆ readLayerDeclaration()

static bool Ogre::Terrain::readLayerDeclaration ( StreamSerialiser ser,
TerrainLayerDeclaration targetdecl 
)
static

Utility method to read a layer declaration from a stream.

◆ writeLayerInstanceList()

static void Ogre::Terrain::writeLayerInstanceList ( const Terrain::LayerInstanceList lst,
StreamSerialiser ser 
)
static

Utility method to write a layer instance list to a stream.

◆ readLayerInstanceList()

static bool Ogre::Terrain::readLayerInstanceList ( StreamSerialiser ser,
size_t  numSamplers,
Terrain::LayerInstanceList targetlst 
)
static

Utility method to read a layer instance list from a stream.

◆ OGRE_RW_MUTEX()

Ogre::Terrain::OGRE_RW_MUTEX ( mNeighbourMutex  )

◆ increaseLodLevel()

void Ogre::Terrain::increaseLodLevel ( bool  synchronous = false)

Increase Terrain's LOD level by 1.

Parameters
synchronousRun synchronously

◆ decreaseLodLevel()

void Ogre::Terrain::decreaseLodLevel ( )

Removes highest LOD level loaded.

Remarks
If there is LOD level load in progress it's load is canceled instead of removal of already loaded one.

◆ getHighestLodPrepared()

int Ogre::Terrain::getHighestLodPrepared ( ) const
inline

◆ getHighestLodLoaded()

int Ogre::Terrain::getHighestLodLoaded ( ) const
inline

◆ getTargetLodLevel()

int Ogre::Terrain::getTargetLodLevel ( ) const
inline

◆ preUpdateSceneGraph()

virtual void Ogre::SceneManager::Listener::preUpdateSceneGraph ( SceneManager source,
Camera camera 
)
inlinevirtualinherited

Called prior to updating the scene graph in this SceneManager.

Remarks
This is called before updating the scene graph for a camera.
Parameters
sourceThe SceneManager instance raising this event.
cameraThe camera being updated.

◆ postUpdateSceneGraph()

virtual void Ogre::SceneManager::Listener::postUpdateSceneGraph ( SceneManager source,
Camera camera 
)
inlinevirtualinherited

Called after updating the scene graph in this SceneManager.

Remarks
This is called after updating the scene graph for a camera.
Parameters
sourceThe SceneManager instance raising this event.
cameraThe camera being updated.

◆ postFindVisibleObjects()

virtual void Ogre::SceneManager::Listener::postFindVisibleObjects ( SceneManager source,
IlluminationRenderStage  irs,
Viewport v 
)
inlinevirtualinherited

Called after searching for visible objects in this SceneManager.

Remarks
Note that the render queue at this stage will be full of the current scenes contents, ready for rendering. You may manually add renderables to this queue if you wish.
Parameters
sourceThe SceneManager instance raising this event.
irsThe stage of illumination being dealt with. IRS_NONE for a regular render, IRS_RENDER_TO_TEXTURE for a shadow caster render.
vThe viewport being updated. You can get the camera from here.

◆ shadowTexturesUpdated()

virtual void Ogre::SceneManager::Listener::shadowTexturesUpdated ( size_t  numberOfShadowTextures)
inlinevirtualinherited

Event raised after all shadow textures have been rendered into for all queues / targets but before any other geometry has been rendered (including main scene geometry and any additional shadow receiver passes).

Remarks
This callback is useful for those that wish to perform some additional processing on shadow textures before they are used to render shadows. For example you could perform some filtering by rendering the existing shadow textures into another alternative shadow texture with a shader.]
Note
This event will only be fired when texture shadows are in use.
Parameters
numberOfShadowTexturesThe number of shadow textures in use

◆ shadowTextureCasterPreViewProj()

virtual void Ogre::SceneManager::Listener::shadowTextureCasterPreViewProj ( Light light,
Camera camera,
size_t  iteration 
)
inlinevirtualinherited

This event occurs just before the view & projection matrices are set for rendering into a shadow texture.

Remarks
You can use this event hook to perform some custom processing, such as altering the camera being used for rendering the light's view, including setting custom view & projection matrices if you want to perform an advanced shadow technique.
Note
This event will only be fired when texture shadows are in use.
Parameters
lightPointer to the light for which shadows are being rendered
cameraPointer to the camera being used to render
iterationFor lights that use multiple shadow textures, the iteration number

◆ shadowTextureReceiverPreViewProj()

virtual void Ogre::SceneManager::Listener::shadowTextureReceiverPreViewProj ( Light light,
Frustum frustum 
)
inlinevirtualinherited

This event occurs just before the view & projection matrices are set for re-rendering a shadow receiver.

Remarks
You can use this event hook to perform some custom processing, such as altering the projection frustum being used for rendering the shadow onto the receiver to perform an advanced shadow technique.
Note
This event will only be fired when texture shadows are in use.
Parameters
lightPointer to the light for which shadows are being rendered
frustumPointer to the projection frustum being used to project the shadow texture

◆ sortLightsAffectingFrustum()

virtual bool Ogre::SceneManager::Listener::sortLightsAffectingFrustum ( LightList lightList)
inlinevirtualinherited

Hook to allow the listener to override the ordering of lights for the entire frustum.

Remarks
Whilst ordinarily lights are sorted per rendered object (
See also
MovableObject::queryLights), texture shadows adds another issue in that, given there is a finite number of shadow textures, we must choose which lights to render texture shadows from based on the entire frustum. These lights should always be listed first in every objects own list, followed by any other lights which will not cast texture shadows (either because they have shadow casting off, or there aren't enough shadow textures to service them).
This hook allows you to override the detailed ordering of the lights per frustum. The default ordering is shadow casters first (which you must also respect if you override this method), and ordered by distance from the camera within those 2 groups. Obviously the closest lights with shadow casting enabled will be listed first. Only lights within the range of the frustum will be in the list.
Parameters
lightListThe list of lights within range of the frustum which you may sort.
Returns
true if you sorted the list, false otherwise.

Friends And Related Function Documentation

◆ TerrainLodManager

friend class TerrainLodManager
friend

Member Data Documentation

◆ TERRAIN_CHUNK_ID

const uint32 Ogre::Terrain::TERRAIN_CHUNK_ID
static

◆ TERRAIN_CHUNK_VERSION

const uint16 Ogre::Terrain::TERRAIN_CHUNK_VERSION
static

◆ TERRAIN_MAX_BATCH_SIZE

const uint16 Ogre::Terrain::TERRAIN_MAX_BATCH_SIZE
static

◆ TERRAIN_GENERATE_MATERIAL_INTERVAL_MS

const uint64 Ogre::Terrain::TERRAIN_GENERATE_MATERIAL_INTERVAL_MS
static

◆ TERRAINLAYERDECLARATION_CHUNK_ID

const uint32 Ogre::Terrain::TERRAINLAYERDECLARATION_CHUNK_ID
static

◆ TERRAINLAYERDECLARATION_CHUNK_VERSION

const uint16 Ogre::Terrain::TERRAINLAYERDECLARATION_CHUNK_VERSION
static

◆ TERRAINLAYERSAMPLER_CHUNK_ID

const uint32 Ogre::Terrain::TERRAINLAYERSAMPLER_CHUNK_ID
static

◆ TERRAINLAYERSAMPLER_CHUNK_VERSION

const uint16 Ogre::Terrain::TERRAINLAYERSAMPLER_CHUNK_VERSION
static

◆ TERRAINLAYERSAMPLERELEMENT_CHUNK_ID

const uint32 Ogre::Terrain::TERRAINLAYERSAMPLERELEMENT_CHUNK_ID
static

◆ TERRAINLAYERSAMPLERELEMENT_CHUNK_VERSION

const uint16 Ogre::Terrain::TERRAINLAYERSAMPLERELEMENT_CHUNK_VERSION
static

◆ TERRAINLAYERINSTANCE_CHUNK_ID

const uint32 Ogre::Terrain::TERRAINLAYERINSTANCE_CHUNK_ID
static

◆ TERRAINLAYERINSTANCE_CHUNK_VERSION

const uint16 Ogre::Terrain::TERRAINLAYERINSTANCE_CHUNK_VERSION
static

◆ TERRAINDERIVEDDATA_CHUNK_ID

const uint32 Ogre::Terrain::TERRAINDERIVEDDATA_CHUNK_ID
static

◆ TERRAINDERIVEDDATA_CHUNK_VERSION

const uint16 Ogre::Terrain::TERRAINDERIVEDDATA_CHUNK_VERSION
static

◆ TERRAINGENERALINFO_CHUNK_ID

const uint32 Ogre::Terrain::TERRAINGENERALINFO_CHUNK_ID
static

◆ TERRAINGENERALINFO_CHUNK_VERSION

const uint16 Ogre::Terrain::TERRAINGENERALINFO_CHUNK_VERSION
static

◆ LOD_MORPH_CUSTOM_PARAM

const size_t Ogre::Terrain::LOD_MORPH_CUSTOM_PARAM
static

◆ DERIVED_DATA_DELTAS

const uint8 Ogre::Terrain::DERIVED_DATA_DELTAS
static

◆ DERIVED_DATA_NORMALS

const uint8 Ogre::Terrain::DERIVED_DATA_NORMALS
static

◆ DERIVED_DATA_LIGHTMAP

const uint8 Ogre::Terrain::DERIVED_DATA_LIGHTMAP
static

◆ DERIVED_DATA_ALL

const uint8 Ogre::Terrain::DERIVED_DATA_ALL
static

◆ WORKQUEUE_DERIVED_DATA_REQUEST

const uint16 Ogre::Terrain::WORKQUEUE_DERIVED_DATA_REQUEST
static

◆ WORKQUEUE_GENERATE_MATERIAL_REQUEST

const uint16 Ogre::Terrain::WORKQUEUE_GENERATE_MATERIAL_REQUEST
static

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