OGRE  1.9
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Protected Attributes | List of all members
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:
+ Collaboration diagram for Ogre::TerrainMaterialGenerator::Profile:

Public Member Functions

 Profile (TerrainMaterialGenerator *parent, const String &name, const String &desc)
 
 Profile (const Profile &prof)
 
virtual ~Profile ()
 
virtual MaterialPtr generate (const Terrain *terrain)=0
 Generate / reuse a material for the terrain. More...
 
virtual MaterialPtr generateForCompositeMap (const Terrain *terrain)=0
 Generate / reuse a material for the terrain. More...
 
const String & getDescription () const
 Get the description of this profile. More...
 
virtual uint8 getMaxLayers (const Terrain *terrain) const =0
 Get the number of layers supported. More...
 
const String & getName () const
 Get the name of this profile. More...
 
TerrainMaterialGenerator * getParent () const
 Get the generator which owns this profile. More...
 
virtual bool isVertexCompressionSupported () const =0
 Compressed vertex format supported? 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)=0
 Request the options needed from the terrain. More...
 
virtual void setLightmapEnabled (bool enabled)=0
 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)=0
 Update params for a terrain. More...
 
virtual void updateParamsForCompositeMap (const MaterialPtr &mat, const Terrain *terrain)=0
 Update params for a terrain. More...
 

Protected Attributes

String mDesc
 
String mName
 
TerrainMaterialGenerator * mParent
 

Detailed Description

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

Definition at line 167 of file OgreTerrainMaterialGenerator.h.

Constructor & Destructor Documentation

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

Definition at line 174 of file OgreTerrainMaterialGenerator.h.

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

Definition at line 176 of file OgreTerrainMaterialGenerator.h.

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

Definition at line 178 of file OgreTerrainMaterialGenerator.h.

Member Function Documentation

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

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

const String& Ogre::TerrainMaterialGenerator::Profile::getDescription ( void  ) const
inline

Get the description of this profile.

Definition at line 184 of file OgreTerrainMaterialGenerator.h.

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

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

Get the name of this profile.

Definition at line 182 of file OgreTerrainMaterialGenerator.h.

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

Get the generator which owns this profile.

Definition at line 180 of file OgreTerrainMaterialGenerator.h.

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

Compressed vertex format supported?

Implemented in Ogre::TerrainMaterialGeneratorA::SM2Profile.

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::Profile::requestOptions ( Terrain *  terrain)
pure virtual

Request the options needed from the terrain.

Implemented in Ogre::TerrainMaterialGeneratorA::SM2Profile.

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

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

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

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

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

Member Data Documentation

String Ogre::TerrainMaterialGenerator::Profile::mDesc
protected

Definition at line 172 of file OgreTerrainMaterialGenerator.h.

String Ogre::TerrainMaterialGenerator::Profile::mName
protected

Definition at line 171 of file OgreTerrainMaterialGenerator.h.

TerrainMaterialGenerator* Ogre::TerrainMaterialGenerator::Profile::mParent
protected

Definition at line 170 of file OgreTerrainMaterialGenerator.h.

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