OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::TerrainMaterialGenerator Class Reference

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

#include <OgreTerrainMaterialGenerator.h>

+ Inheritance diagram for Ogre::TerrainMaterialGenerator:
+ Collaboration diagram for Ogre::TerrainMaterialGenerator:

Classes

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

Public Types

typedef vector< Profile * >::type 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...
 
ProfilegetActiveProfile () 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 ProfileListgetProfiles () 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...
 
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 More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
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...
 

Protected Attributes

ProfilemActiveProfile
 
unsigned long long int mChangeCounter
 
CameramCompositeMapCam
 
LightmCompositeMapLight
 
ManualObjectmCompositeMapPlane
 
TexturemCompositeMapRTT
 
SceneManagermCompositeMapSM
 
unsigned int mDebugLevel
 
TerrainLayerDeclaration mLayerDecl
 
ProfileList mProfiles
 
CompositorWorkspacemWorkspace
 

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

Definition at line 161 of file OgreTerrainMaterialGenerator.h.

Member Typedef Documentation

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

Definition at line 212 of file OgreTerrainMaterialGenerator.h.

Constructor & Destructor Documentation

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

Member Function Documentation

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

Definition at line 395 of file OgreTerrainMaterialGenerator.h.

void Ogre::TerrainMaterialGenerator::_markChanged ( )
inline

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

Helper method to render a composite map.

Parameters
sizeThe requested composite map size
rectThe region of the composite map to update, in image space
matThe material to use to render the map
destCompositeMapA TexturePtr for the composite map to be written into
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.

Definition at line 271 of file OgreTerrainMaterialGenerator.h.

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

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

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
inline

Get the active profile.

Definition at line 245 of file OgreTerrainMaterialGenerator.h.

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.

Definition at line 260 of file OgreTerrainMaterialGenerator.h.

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

Get the debug level of the material.

Definition at line 384 of file OgreTerrainMaterialGenerator.h.

virtual const TerrainLayerDeclaration& Ogre::TerrainMaterialGenerator::getLayerDeclaration ( ) const
inlinevirtual

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
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.

Definition at line 325 of file OgreTerrainMaterialGenerator.h.

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

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

Get the list of profiles that this generator supports.

Definition at line 216 of file OgreTerrainMaterialGenerator.h.

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.

Definition at line 279 of file OgreTerrainMaterialGenerator.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

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

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

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

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

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

Definition at line 91 of file OgreMemoryAllocatedObject.h.

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

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

Set the active profile by name.

Definition at line 219 of file OgreTerrainMaterialGenerator.h.

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

Set the active Profile.

Definition at line 236 of file OgreTerrainMaterialGenerator.h.

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.

Definition at line 375 of file OgreTerrainMaterialGenerator.h.

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

Definition at line 316 of file OgreTerrainMaterialGenerator.h.

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

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.

Definition at line 340 of file OgreTerrainMaterialGenerator.h.

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

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

Update parameters for the given terrain using the active profile.

Definition at line 352 of file OgreTerrainMaterialGenerator.h.

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

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

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

Definition at line 360 of file OgreTerrainMaterialGenerator.h.

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

Member Data Documentation

Profile* Ogre::TerrainMaterialGenerator::mActiveProfile
mutableprotected

Definition at line 399 of file OgreTerrainMaterialGenerator.h.

unsigned long long int Ogre::TerrainMaterialGenerator::mChangeCounter
protected

Definition at line 400 of file OgreTerrainMaterialGenerator.h.

Camera* Ogre::TerrainMaterialGenerator::mCompositeMapCam
protected

Definition at line 404 of file OgreTerrainMaterialGenerator.h.

Light* Ogre::TerrainMaterialGenerator::mCompositeMapLight
protected

Definition at line 408 of file OgreTerrainMaterialGenerator.h.

ManualObject* Ogre::TerrainMaterialGenerator::mCompositeMapPlane
protected

Definition at line 407 of file OgreTerrainMaterialGenerator.h.

Texture* Ogre::TerrainMaterialGenerator::mCompositeMapRTT
protected

Definition at line 405 of file OgreTerrainMaterialGenerator.h.

SceneManager* Ogre::TerrainMaterialGenerator::mCompositeMapSM
protected

Definition at line 403 of file OgreTerrainMaterialGenerator.h.

unsigned int Ogre::TerrainMaterialGenerator::mDebugLevel
protected

Definition at line 402 of file OgreTerrainMaterialGenerator.h.

TerrainLayerDeclaration Ogre::TerrainMaterialGenerator::mLayerDecl
protected

Definition at line 401 of file OgreTerrainMaterialGenerator.h.

ProfileList Ogre::TerrainMaterialGenerator::mProfiles
protected

Definition at line 398 of file OgreTerrainMaterialGenerator.h.

CompositorWorkspace* Ogre::TerrainMaterialGenerator::mWorkspace
protected

Definition at line 406 of file OgreTerrainMaterialGenerator.h.


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