| OGRE 1.11.1 Object-Oriented Graphics Rendering Engine

Classes | Public Types | Public Member Functions | List of all members
Ogre::TerrainMaterialGenerator Class Reference
Optional Components » Terrain

Class that provides functionality to generate materials for use with a terrain. More...

`#include <OgreTerrainMaterialGenerator.h>`

Inheritance diagram for Ogre::TerrainMaterialGenerator:
[legend]

## Classes
class | Profile
| Inner class which should also be subclassed to provide profile-specific material generation. More...

## Public Types
typedef std::vector< Profile * > | ProfileList
| List of profiles - NB should be ordered in descending complexity. More...

## Public Member Functions
| TerrainMaterialGenerator ()
virtual | ~TerrainMaterialGenerator ()
Texture * | _getCompositeMapRTT ()
void | _markChanged ()
| Internal method - indicates that a change has been made that would require material regeneration. More...
virtual void | _renderCompositeMap (size_t size, const Rect &rect, const MaterialPtr &mat, const TexturePtr &destCompositeMap)
| Helper method to render a composite map. More...
virtual bool | canGenerateUsingDeclaration (const TerrainLayerDeclaration &decl)
| Whether this generator can generate a material for a given declaration. More...
virtual MaterialPtr | generate (const Terrain *terrain)
| Generate a material for the given terrain using the active profile. More...
virtual MaterialPtr | generateForCompositeMap (const Terrain *terrain)
| Generate a material for the given composite map of the terrain using the active profile. More...
Profile * | getActiveProfile () const
| Get the active profile. More...
unsigned long long int | getChangeCount () const
| Returns the number of times the generator has undergone a change which would require materials to be regenerated. More...
virtual unsigned int | getDebugLevel () const
| Get the debug level of the material. More...
virtual const TerrainLayerDeclaration & | getLayerDeclaration () const
| Get the layer declaration that this material generator operates with. More...
virtual uint8 | getMaxLayers (const Terrain *terrain) const
| Get the maximum number of layers supported with the given terrain. More...
virtual const ProfileList & | getProfiles () const
| Get the list of profiles that this generator supports. More...
virtual bool | isVertexCompressionSupported () const
| Return whether this material generator supports using a compressed vertex format. More...
virtual void | requestOptions (Terrain *terrain)
| Triggers the generator to request the options that it needs. More...
virtual void | setActiveProfile (const String &name)
| Set the active profile by name. More...
virtual void | setActiveProfile (Profile *p)
| Set the active Profile. More...
virtual void | setDebugLevel (unsigned int dbg)
| Set the debug level of the material. More...
virtual void | setLightmapEnabled (bool enabled)
| Whether to support a light map over the terrain in the shader, if it's present (default true). More...
virtual void | updateCompositeMap (const Terrain *terrain, const Rect &rect)
| Update the composite map for a terrain. More...
virtual void | updateParams (const MaterialPtr &mat, const Terrain *terrain)
| Update parameters for the given terrain using the active profile. More...
virtual void | updateParamsForCompositeMap (const MaterialPtr &mat, const Terrain *terrain)
| Update parameters for the given terrain composite map using the active profile. More...

## Detailed Description

Class that provides functionality to generate materials for use with a terrain.

Remarks
  Terrains are composed of one or more layers of texture information, and require that a material is generated to render them. There are various approaches to rendering the terrain, which may vary due to:
  - Hardware support (static)
  - Texture instances assigned to a particular terrain (dynamic in an editor)
  - User selection (e.g. changing to a cheaper option in order to increase performance, or in order to test how the material might look on other hardware (dynamic)
  Subclasses of this class are responsible for responding to these factors and to generate a terrain material.

  In order to cope with both hardware support and user selection, the generator must expose a number of named 'profiles'. These profiles should function on a known range of hardware, and be graded by quality. At runtime, the user should be able to select the profile they wish to use (provided hardware support is available).

## Member Typedef Documentation

## ◆ ProfileList

typedef std::vector<Profile*> Ogre::TerrainMaterialGenerator::ProfileList

List of profiles - NB should be ordered in descending complexity.

## Constructor & Destructor Documentation

## ◆ TerrainMaterialGenerator()

Ogre::TerrainMaterialGenerator::TerrainMaterialGenerator | ( |  | ) |

## ◆ ~TerrainMaterialGenerator()

virtual Ogre::TerrainMaterialGenerator::~TerrainMaterialGenerator | ( |  | ) |
| virtual

## Member Function Documentation

## ◆ getProfiles()

virtual const ProfileList& Ogre::TerrainMaterialGenerator::getProfiles | ( |  | ) | const
| inline virtual

Get the list of profiles that this generator supports.

## ◆ setActiveProfile() [1/2]

virtual void Ogre::TerrainMaterialGenerator::setActiveProfile | ( | const String & | name | ) |
| inline virtual

Set the active profile by name.

## ◆ setActiveProfile() [2/2]

virtual void Ogre::TerrainMaterialGenerator::setActiveProfile | ( | Profile * | p | ) |
| inline virtual

Set the active Profile.

## ◆ getActiveProfile()

Profile* Ogre::TerrainMaterialGenerator::getActiveProfile | ( |  | ) | const
| inline

Get the active profile.

## ◆ _markChanged()

void Ogre::TerrainMaterialGenerator::_markChanged | ( |  | ) |
| inline

Internal method - indicates that a change has been made that would require material regeneration.

## ◆ getChangeCount()

unsigned long long int Ogre::TerrainMaterialGenerator::getChangeCount | ( |  | ) | const
| inline

Returns the number of times the generator has undergone a change which would require materials to be regenerated.

## ◆ getLayerDeclaration()

virtual const TerrainLayerDeclaration& Ogre::TerrainMaterialGenerator::getLayerDeclaration | ( |  | ) | const
| inline virtual

Get the layer declaration that this material generator operates with.

## ◆ canGenerateUsingDeclaration()

virtual bool Ogre::TerrainMaterialGenerator::canGenerateUsingDeclaration | ( | const TerrainLayerDeclaration & | decl | ) |
| inline virtual

Whether this generator can generate a material for a given declaration.

By default this only returns true if the declaration is equal to the standard one returned from getLayerDeclaration, but if a subclass wants to be flexible to generate materials for other declarations too, it can specify here.

## ◆ isVertexCompressionSupported()

virtual bool Ogre::TerrainMaterialGenerator::isVertexCompressionSupported | ( |  | ) | const
| inline virtual

Return whether this material generator supports using a compressed vertex format.

This is only possible when using shaders.

## ◆ requestOptions()

virtual void Ogre::TerrainMaterialGenerator::requestOptions | ( | Terrain * | terrain | ) |
| inline virtual

Triggers the generator to request the options that it needs.

References Ogre::TerrainMaterialGenerator::Profile::requestOptions().

## ◆ generate()

virtual MaterialPtr Ogre::TerrainMaterialGenerator::generate | ( | const Terrain * | terrain | ) |
| inline virtual

Generate a material for the given terrain using the active profile.

References Ogre::TerrainMaterialGenerator::Profile::generate().

## ◆ generateForCompositeMap()

virtual MaterialPtr Ogre::TerrainMaterialGenerator::generateForCompositeMap | ( | const Terrain * | terrain | ) |
| inline virtual

Generate a material for the given composite map of the terrain using the active profile.

References Ogre::TerrainMaterialGenerator::Profile::generateForCompositeMap().

## ◆ setLightmapEnabled()

virtual void Ogre::TerrainMaterialGenerator::setLightmapEnabled | ( | bool | enabled | ) |
| inline virtual

Whether to support a light map over the terrain in the shader, if it's present (default true).

References Ogre::TerrainMaterialGenerator::Profile::setLightmapEnabled().

## ◆ getMaxLayers()

virtual uint8 Ogre::TerrainMaterialGenerator::getMaxLayers | ( | const Terrain * | terrain | ) | const
| inline virtual

Get the maximum number of layers supported with the given terrain.

Note
  When you change the options on the terrain, this value can change.

References Ogre::TerrainMaterialGenerator::Profile::getMaxLayers().

## ◆ updateCompositeMap()

virtual void Ogre::TerrainMaterialGenerator::updateCompositeMap | ( | const Terrain * | terrain,
|  | const Rect & | rect
| ) |  |
| inline virtual

Update the composite map for a terrain.

The composite map for a terrain must match what the terrain should look like at distance. This method will only be called in the render thread so the generator is free to render into a texture to support this, so long as the results are blitted into the Terrain's own composite map afterwards.

References Ogre::TerrainMaterialGenerator::Profile::updateCompositeMap().

## ◆ updateParams()

virtual void Ogre::TerrainMaterialGenerator::updateParams | ( | const MaterialPtr & | mat,
|  | const Terrain * | terrain
| ) |  |
| inline virtual

Update parameters for the given terrain using the active profile.

References Ogre::TerrainMaterialGenerator::Profile::updateParams().

## ◆ updateParamsForCompositeMap()

virtual void Ogre::TerrainMaterialGenerator::updateParamsForCompositeMap | ( | const MaterialPtr & | mat,
|  | const Terrain * | terrain
| ) |  |
| inline virtual

Update parameters for the given terrain composite map using the active profile.

References Ogre::TerrainMaterialGenerator::Profile::updateParamsForCompositeMap().

## ◆ setDebugLevel()

virtual void Ogre::TerrainMaterialGenerator::setDebugLevel | ( | unsigned int | dbg | ) |
| inline virtual

Set the debug level of the material.

Remarks
  Sets the level of debug display for this material. What this debug level means is entirely depdendent on the generator, the only constant is that 0 means 'no debug' and non-zero means 'some level of debugging', with any graduations in non-zero values being generator-specific.

## ◆ getDebugLevel()

virtual unsigned int Ogre::TerrainMaterialGenerator::getDebugLevel | ( |  | ) | const
| inline virtual

Get the debug level of the material.

## ◆ _renderCompositeMap()

virtual void Ogre::TerrainMaterialGenerator::_renderCompositeMap | ( | size_t | size,
|  | const Rect & | rect,
|  | const MaterialPtr & | mat,
|  | const TexturePtr & | destCompositeMap
| ) |  |
| virtual

Helper method to render a composite map.

Parameters

  size | The requested composite map size
  rect | The region of the composite map to update, in image space
  mat | The material to use to render the map
  destCompositeMap | A TexturePtr for the composite map to be written into

## ◆ _getCompositeMapRTT()

Texture* Ogre::TerrainMaterialGenerator::_getCompositeMapRTT | ( |  | ) |
| inline

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

- OgreTerrainMaterialGenerator.h