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

#include <OgreTerrainMaterialGenerator.h>

Inheritance diagram for Ogre::TerrainMaterialGenerator:

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.

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

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

Referenced by Ogre::TerrainMaterialGenerator::Profile::Profile(), Ogre::TerrainMaterialGeneratorA::SM2Profile::SM2Profile(), and Ogre::TerrainMaterialGenerator::Profile::getParent().

◆ ~TerrainMaterialGenerator()

virtual Ogre::TerrainMaterialGenerator::~TerrainMaterialGenerator ( )

virtual

Member Function Documentation

◆ getProfiles()

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

inlinevirtual

Get the list of profiles that this generator supports.

◆ setActiveProfile() [1/2]

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

inlinevirtual

Set the active profile by name.

References setActiveProfile().

Referenced by setActiveProfile().

◆ setActiveProfile() [2/2]

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

inlinevirtual

Set the active Profile.

References _markChanged().

◆ getActiveProfile()

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

inline

Get the active profile.

Referenced by generate(), generateForCompositeMap(), getMaxLayers(), isVertexCompressionSupported(), requestOptions(), setLightmapEnabled(), updateCompositeMap(), updateParams(), and updateParamsForCompositeMap().

◆ _markChanged()

void Ogre::TerrainMaterialGenerator::_markChanged ( )

inline

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

Referenced by setActiveProfile(), and setDebugLevel().

◆ 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

inlinevirtual

Get the layer declaration that this material generator operates with.

◆ canGenerateUsingDeclaration()

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

inlinevirtual

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

inlinevirtual

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

This is only possible when using shaders.

References getActiveProfile().

◆ requestOptions()

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

inlinevirtual

Triggers the generator to request the options that it needs.

References getActiveProfile(), and Ogre::TerrainMaterialGenerator::Profile::requestOptions().

◆ generate()

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

inlinevirtual

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

References Ogre::TerrainMaterialGenerator::Profile::generate(), and getActiveProfile().

◆ generateForCompositeMap()

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

inlinevirtual

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

References Ogre::TerrainMaterialGenerator::Profile::generateForCompositeMap(), and getActiveProfile().

◆ setLightmapEnabled()

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

inlinevirtual

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

References getActiveProfile(), and Ogre::TerrainMaterialGenerator::Profile::setLightmapEnabled().

◆ getMaxLayers()

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

inlinevirtual

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 getActiveProfile(), and Ogre::TerrainMaterialGenerator::Profile::getMaxLayers().

◆ updateCompositeMap()

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

inlinevirtual

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 getActiveProfile(), and Ogre::TerrainMaterialGenerator::Profile::updateCompositeMap().

◆ updateParams()

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

inlinevirtual

Update parameters for the given terrain using the active profile.

References getActiveProfile(), and Ogre::TerrainMaterialGenerator::Profile::updateParams().

◆ updateParamsForCompositeMap()

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

inlinevirtual

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

References getActiveProfile(), and Ogre::TerrainMaterialGenerator::Profile::updateParamsForCompositeMap().

◆ setDebugLevel()

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

inlinevirtual

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.

References _markChanged().

◆ getDebugLevel()

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

inlinevirtual

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

Classes

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ ProfileList

Constructor & Destructor Documentation

◆ TerrainMaterialGenerator()

◆ ~TerrainMaterialGenerator()

Member Function Documentation

◆ getProfiles()

◆ setActiveProfile() [1/2]

◆ setActiveProfile() [2/2]

◆ getActiveProfile()

◆ _markChanged()

◆ getChangeCount()

◆ getLayerDeclaration()

◆ canGenerateUsingDeclaration()

◆ isVertexCompressionSupported()

◆ requestOptions()

◆ generate()

◆ generateForCompositeMap()

◆ setLightmapEnabled()

◆ getMaxLayers()

◆ updateCompositeMap()

◆ updateParams()

◆ updateParamsForCompositeMap()

◆ setDebugLevel()

◆ getDebugLevel()

◆ _renderCompositeMap()

◆ _getCompositeMapRTT()