OgreHeightmap Class Reference

Ogre implementation of a heightmap geometry. More...

#include <OgreHeightmap.hh>

Public Member Functions
virtual	~OgreHeightmap ()
	Destructor.
virtual void	Init () override
virtual MaterialPtr	Material () const override
	Returns NULL, heightmap materials don't inherit from MaterialPtr.
virtual Ogre::MovableObject *	OgreObject () const override
	Returns NULL, heightmaps don't have movable objects.
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.
virtual void	SetMaterial (MaterialPtr _material, bool _unique) override
	Has no effect for heightmaps. The material is set through a HeightmapDescriptor.
Public Member Functions inherited from BaseHeightmap< OgreGeometry >
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.
Public Member Functions inherited from Geometry
virtual	~Geometry ()
	Destructor.
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 Member Functions inherited from OgreGeometry
virtual	~OgreGeometry ()
virtual bool	HasParent () const
	Determine if this Geometry is attached to a Visual.
virtual VisualPtr	Parent () const
	Get the parent Visual.
Public Member Functions inherited from BaseGeometry< OgreObject >
virtual	~BaseGeometry ()
virtual GeometryPtr	Clone () const override
	Clone the geometry.
virtual void	RemoveParent () override
	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 &_material, bool _unique=true) override
	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.
Public Member Functions inherited from OgreObject
virtual	~OgreObject ()
virtual ScenePtr	Scene () const
Public Member Functions inherited from BaseObject
virtual	~BaseObject ()
virtual unsigned int	Id () const override
virtual std::string	Name () const override
virtual void	PostRender () override

Protected Member Functions
	OgreHeightmap (const HeightmapDescriptor &_desc)
	Constructor.
Protected Member Functions inherited from BaseHeightmap< OgreGeometry >
	BaseHeightmap (const HeightmapDescriptor &_desc)
	Constructor.
Protected Member Functions inherited from OgreGeometry
	OgreGeometry ()
virtual void	SetParent (OgreVisualPtr _parent)
Protected Member Functions inherited from BaseGeometry< OgreObject >
	BaseGeometry ()
Protected Member Functions inherited from OgreObject
	OgreObject ()
Protected Member Functions inherited from BaseObject
	BaseObject ()
virtual void	Load ()

Additional Inherited Members
Public Attributes inherited from BaseHeightmap< OgreGeometry >
HeightmapDescriptor	descriptor
	Descriptor containing heightmap information.
Protected Attributes inherited from OgreGeometry
OgreVisualPtr	parent
Protected Attributes inherited from OgreObject
OgreScenePtr	scene
Protected Attributes inherited from BaseObject
unsigned int	id
std::string	name

Detailed Description

Ogre implementation of a heightmap geometry.

Constructor & Destructor Documentation

OgreHeightmap()

OgreHeightmap ( const HeightmapDescriptor &  _desc )

explicitprotected

Constructor.

~OgreHeightmap()

virtual ~OgreHeightmap ( )

virtual

Destructor.

Member Function Documentation

Init()

virtual void Init ( )

overridevirtual

Reimplemented from BaseObject.

Material()

virtual MaterialPtr Material ( ) const

overridevirtual

Returns NULL, heightmap materials don't inherit from MaterialPtr.

Returns

Null pointer.

Implements Geometry.

OgreObject()

virtual Ogre::MovableObject * OgreObject ( ) const

overridevirtual

Returns NULL, heightmaps don't have movable objects.

Returns

Null pointer.

Implements OgreGeometry.

PreRender()

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

Reimplemented from BaseHeightmap< OgreGeometry >.

SetMaterial()

virtual void SetMaterial ( MaterialPtr  _material, bool  _unique  )

overridevirtual

Has no effect for heightmaps. The material is set through a HeightmapDescriptor.

Parameters

[in]	_material	Not used.
[in]	_unique	Not used.

Implements Geometry.

---

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

• OgreHeightmap.hh