OGRE 1.12.10
Object-Oriented Graphics Rendering Engine
Loading...
Searching...
No Matches
Ogre::TerrainMaterialGenerator::Profile Class Referenceabstract

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

#include <OgreTerrainMaterialGenerator.h>

Inheritance diagram for Ogre::TerrainMaterialGenerator::Profile:

Public Member Functions

 Profile (const Profile &prof)
 Profile (TerrainMaterialGenerator *parent, const String &name, const String &desc)
virtual ~Profile ()
virtual MaterialPtr generate (const Terrain *terrain)=0
 Generate / reuse a material for the terrain.
virtual MaterialPtr generateForCompositeMap (const Terrain *terrain)=0
 Generate / reuse a material for the terrain.
const String & getDescription () const
virtual uint8 getMaxLayers (const Terrain *terrain) const =0
 Get the number of layers supported.
const String & getName () const
 Get the name of this profile.
TerrainMaterialGenerator * getParent () const
 Get the generator which owns this profile.
virtual bool isVertexCompressionSupported () const =0
 Compressed vertex format supported?
virtual void requestOptions (Terrain *terrain)=0
 Request the options needed from the terrain.
virtual void setLightmapEnabled (bool enabled)=0
 Whether to support a light map over the terrain in the shader, if it's present (default true).
virtual void updateCompositeMap (const Terrain *terrain, const Rect &rect)
 Update the composite map for a terrain.
virtual void updateParams (const MaterialPtr &mat, const Terrain *terrain)=0
 Update params for a terrain.
virtual void updateParamsForCompositeMap (const MaterialPtr &mat, const Terrain *terrain)=0
 Update params for a terrain.

Detailed Description

Inner class which should also be subclassed to provide profile-specific material generation.

Constructor & Destructor Documentation

◆ Profile() [1/2]

Ogre::TerrainMaterialGenerator::Profile::Profile ( TerrainMaterialGenerator * parent,
const String & name,
const String & desc )
inline

References Ogre::TerrainMaterialGenerator::TerrainMaterialGenerator().

Referenced by Profile().

◆ Profile() [2/2]

Ogre::TerrainMaterialGenerator::Profile::Profile ( const Profile & prof)
inline

References Profile().

◆ ~Profile()

virtual Ogre::TerrainMaterialGenerator::Profile::~Profile ( )
inlinevirtual

Member Function Documentation

◆ getParent()

TerrainMaterialGenerator * Ogre::TerrainMaterialGenerator::Profile::getParent ( ) const
inline

Get the generator which owns this profile.

References Ogre::TerrainMaterialGenerator::TerrainMaterialGenerator().

◆ getName()

const String & Ogre::TerrainMaterialGenerator::Profile::getName ( ) const
inline

Get the name of this profile.

◆ getDescription()

const String & Ogre::TerrainMaterialGenerator::Profile::getDescription ( ) const
inline
Deprecated
do not use

◆ isVertexCompressionSupported()

virtual bool Ogre::TerrainMaterialGenerator::Profile::isVertexCompressionSupported ( ) const
pure virtual

Compressed vertex format supported?

Implemented in Ogre::TerrainMaterialGeneratorA::SM2Profile.

◆ generate()

virtual MaterialPtr Ogre::TerrainMaterialGenerator::Profile::generate ( const Terrain * terrain)
pure virtual

Generate / reuse a material for the terrain.

Implemented in Ogre::TerrainMaterialGeneratorA::SM2Profile.

Referenced by Ogre::TerrainMaterialGenerator::generate().

◆ generateForCompositeMap()

virtual MaterialPtr Ogre::TerrainMaterialGenerator::Profile::generateForCompositeMap ( const Terrain * terrain)
pure virtual

Generate / reuse a material for the terrain.

Implemented in Ogre::TerrainMaterialGeneratorA::SM2Profile.

Referenced by Ogre::TerrainMaterialGenerator::generateForCompositeMap().

◆ setLightmapEnabled()

virtual void Ogre::TerrainMaterialGenerator::Profile::setLightmapEnabled ( bool enabled)
pure virtual

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

Implemented in Ogre::TerrainMaterialGeneratorA::SM2Profile.

Referenced by Ogre::TerrainMaterialGenerator::setLightmapEnabled().

◆ getMaxLayers()

virtual uint8 Ogre::TerrainMaterialGenerator::Profile::getMaxLayers ( const Terrain * terrain) const
pure virtual

Get the number of layers supported.

Implemented in Ogre::TerrainMaterialGeneratorA::SM2Profile.

Referenced by Ogre::TerrainMaterialGenerator::getMaxLayers().

◆ updateCompositeMap()

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

Update the composite map for a terrain.

Referenced by Ogre::TerrainMaterialGenerator::updateCompositeMap().

◆ updateParams()

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

Update params for a terrain.

Implemented in Ogre::TerrainMaterialGeneratorA::SM2Profile.

Referenced by Ogre::TerrainMaterialGenerator::updateParams().

◆ updateParamsForCompositeMap()

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

Update params for a terrain.

Implemented in Ogre::TerrainMaterialGeneratorA::SM2Profile.

Referenced by Ogre::TerrainMaterialGenerator::updateParamsForCompositeMap().

◆ requestOptions()

virtual void Ogre::TerrainMaterialGenerator::Profile::requestOptions ( Terrain * terrain)
pure virtual

Request the options needed from the terrain.

Implemented in Ogre::TerrainMaterialGeneratorA::SM2Profile.

Referenced by Ogre::TerrainMaterialGenerator::requestOptions().

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