BaseHeightmap< T > Class Template Reference

#include <BaseHeightmap.hh>

Public Member Functions
virtual const HeightmapDescriptor &	Descriptor () override
	Get the immutable heightmap descriptor.
virtual void	Destroy () override
	Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior.
virtual void	PreRender () override
	Prepare this object and any of its children for rendering. This should be called for each object in a scene just before rendering, which can be achieved by a single call to Scene::PreRender.
Public Member Functions inherited from Geometry
virtual	~Geometry ()
	Destructor.
virtual GeometryPtr	Clone () const =0
	Clone the geometry.
virtual bool	HasParent () const =0
	Determine if this Geometry is attached to a Visual.
virtual MaterialPtr	Material () const =0
	Get the material of this geometry.
virtual VisualPtr	Parent () const =0
	Get the parent Visual.
virtual void	RemoveParent ()=0
	Detach this Geometry from its parent Visual. If this Geometry does not have a parent, no work will be done.
virtual void	SetMaterial (const std::string &_name, bool _unique=true)=0
	Set the materials of this Geometry. The specified material will be retrieved from the parent Scene. If no material is registered by the given name, no work will be done.
virtual void	SetMaterial (MaterialPtr _material, bool _unique=true)=0
	Set the materials of this Geometry.
Public Member Functions inherited from Object
virtual	~Object ()
	Destructor.
virtual unsigned int	Id () const =0
	Get the object ID. This ID will be unique across all objects inside a given scene, but necessarily true for objects across different scenes.
virtual std::string	Name () const =0
	Get the object name. This name will be unique across all objects inside a given scene, but necessarily true for objects across different scenes.
virtual void	PostRender ()=0
	Post process this object and any of its children after rendering.
virtual ScenePtr	Scene () const =0
	Get the Scene that created this object.

Public Attributes
HeightmapDescriptor	descriptor
	Descriptor containing heightmap information.

Protected Member Functions
	BaseHeightmap (const HeightmapDescriptor &_desc)
	Constructor.

Constructor & Destructor Documentation

BaseHeightmap()

template<class T >

BaseHeightmap ( const HeightmapDescriptor &  _desc )

explicitprotected

Constructor.

Parameters

[in]

_desc

Descriptor containing heightmap information.

Member Function Documentation

Descriptor()

template<class T >

const HeightmapDescriptor & Descriptor ( )

overridevirtual

Get the immutable heightmap descriptor.

Returns

Descriptor with heightmap information.

Implements Heightmap.

Destroy()

template<class T >

void Destroy ( )

overridevirtual

Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior.

Implements Object.

Reimplemented in Ogre2Heightmap.

PreRender()

template<class T >

void PreRender ( )

overridevirtual

Prepare this object and any of its children for rendering. This should be called for each object in a scene just before rendering, which can be achieved by a single call to Scene::PreRender.

Implements Object.

Reimplemented in OgreHeightmap, and Ogre2Heightmap.

Member Data Documentation

descriptor

template<class T >

HeightmapDescriptor descriptor

Descriptor containing heightmap information.

---

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

• BaseHeightmap.hh