A TerrainMaterialGenerator which can cope with normal mapped, specular mapped terrain. More...

#include <OgreTerrainMaterialGeneratorA.h>

Inheritance diagram for Ogre::TerrainMaterialGeneratorA:

Classes
class	SM2Profile
	Shader model 2 profile target. More...
Public Types
typedef vector< Profile * >::type	ProfileList
	List of profiles - NB should be ordered in descending complexity.
Public Member Functions
	TerrainMaterialGeneratorA ()
virtual	~TerrainMaterialGeneratorA ()
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.
void	operator delete (void *ptr)
void	operator delete (void ptr, void )
void	operator delete (void ptr, const char , int, const char *)
void	operator delete[] (void *ptr)
void	operator delete[] (void ptr, const char , int, const char *)
void *	operator new (size_t sz, const char file, int line, const char func)
	operator new, with debug line info
void *	operator new (size_t sz)
void *	operator new (size_t sz, void *ptr)
	placement operator new
void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info
void *	operator new[] (size_t sz)
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.
Protected Attributes
Profile *	mActiveProfile
unsigned long long int	mChangeCounter
Camera *	mCompositeMapCam
Light *	mCompositeMapLight
ManualObject *	mCompositeMapPlane
Texture *	mCompositeMapRTT
SceneManager *	mCompositeMapSM
unsigned int	mDebugLevel
TerrainLayerDeclaration	mLayerDecl
ProfileList	mProfiles

Detailed Description

A TerrainMaterialGenerator which can cope with normal mapped, specular mapped terrain.

Note:: Requires the Cg plugin to render correctly

Definition at line 53 of file OgreTerrainMaterialGeneratorA.h.

Member Typedef Documentation

typedef vector<Profile*>::type Ogre::TerrainMaterialGenerator::ProfileList [inherited]

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

Definition at line 212 of file OgreTerrainMaterialGenerator.h.

Constructor & Destructor Documentation

Ogre::TerrainMaterialGeneratorA::TerrainMaterialGeneratorA ( )

virtual Ogre::TerrainMaterialGeneratorA::~TerrainMaterialGeneratorA ( ) [virtual]

Member Function Documentation

Texture* Ogre::TerrainMaterialGenerator::_getCompositeMapRTT ( ) [inherited]

Definition at line 395 of file OgreTerrainMaterialGenerator.h.

void Ogre::TerrainMaterialGenerator::_markChanged ( ) [inherited]

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

Definition at line 255 of file OgreTerrainMaterialGenerator.h.

virtual void Ogre::TerrainMaterialGenerator::_renderCompositeMap	(	size_t	size,
		const Rect &	rect,
		const MaterialPtr &	mat,
		const TexturePtr &	destCompositeMap
	)		`[virtual, inherited]`

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

virtual bool Ogre::TerrainMaterialGenerator::canGenerateUsingDeclaration ( const TerrainLayerDeclaration & decl ) [virtual, inherited]

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.

Definition at line 271 of file OgreTerrainMaterialGenerator.h.

virtual MaterialPtr Ogre::TerrainMaterialGenerator::generate ( const Terrain * terrain ) [virtual, inherited]

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

Definition at line 295 of file OgreTerrainMaterialGenerator.h.

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

virtual MaterialPtr Ogre::TerrainMaterialGenerator::generateForCompositeMap ( const Terrain * terrain ) [virtual, inherited]

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

Definition at line 305 of file OgreTerrainMaterialGenerator.h.

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

Profile* Ogre::TerrainMaterialGenerator::getActiveProfile ( ) const [inherited]

Get the active profile.

Definition at line 245 of file OgreTerrainMaterialGenerator.h.

unsigned long long int Ogre::TerrainMaterialGenerator::getChangeCount ( ) const [inherited]

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

Definition at line 260 of file OgreTerrainMaterialGenerator.h.

virtual unsigned int Ogre::TerrainMaterialGenerator::getDebugLevel ( ) const [virtual, inherited]

Get the debug level of the material.

Definition at line 384 of file OgreTerrainMaterialGenerator.h.

virtual const TerrainLayerDeclaration& Ogre::TerrainMaterialGenerator::getLayerDeclaration ( ) const [virtual, inherited]

Get the layer declaration that this material generator operates with.

Definition at line 264 of file OgreTerrainMaterialGenerator.h.

virtual uint8 Ogre::TerrainMaterialGenerator::getMaxLayers ( const Terrain * terrain ) const [virtual, inherited]

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

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

Definition at line 325 of file OgreTerrainMaterialGenerator.h.

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

virtual const ProfileList& Ogre::TerrainMaterialGenerator::getProfiles ( ) const [virtual, inherited]

Get the list of profiles that this generator supports.

Definition at line 216 of file OgreTerrainMaterialGenerator.h.

virtual bool Ogre::TerrainMaterialGenerator::isVertexCompressionSupported ( ) const [virtual, inherited]

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

This is only possible when using shaders.

Definition at line 279 of file OgreTerrainMaterialGenerator.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void * ptr ) [inherited]

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		void *
	)		`[inherited]`

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)		`[inherited]`

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void * ptr ) [inherited]

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[]	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)		`[inherited]`

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)		`[inherited]`

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new ( size_t sz ) [inherited]

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		void *	ptr
	)		`[inherited]`

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[]	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)		`[inherited]`

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t sz ) [inherited]

Definition at line 91 of file OgreMemoryAllocatedObject.h.

virtual void Ogre::TerrainMaterialGenerator::requestOptions ( Terrain * terrain ) [virtual, inherited]

Triggers the generator to request the options that it needs.

Definition at line 286 of file OgreTerrainMaterialGenerator.h.

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

virtual void Ogre::TerrainMaterialGenerator::setActiveProfile ( const String & name ) [virtual, inherited]

Set the active profile by name.

Definition at line 219 of file OgreTerrainMaterialGenerator.h.

virtual void Ogre::TerrainMaterialGenerator::setActiveProfile ( Profile * p ) [virtual, inherited]

Set the active Profile.

Definition at line 236 of file OgreTerrainMaterialGenerator.h.

virtual void Ogre::TerrainMaterialGenerator::setDebugLevel ( unsigned int dbg ) [virtual, inherited]

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.

Definition at line 375 of file OgreTerrainMaterialGenerator.h.

virtual void Ogre::TerrainMaterialGenerator::setLightmapEnabled ( bool enabled ) [virtual, inherited]

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

Definition at line 316 of file OgreTerrainMaterialGenerator.h.

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

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

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.

Definition at line 340 of file OgreTerrainMaterialGenerator.h.

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