Ogre2Heightmap Class Reference

Ogre implementation of a heightmap geometry. More...

#include <Ogre2Heightmap.hh>

Public Member Functions
	Ogre2Heightmap (const HeightmapDescriptor &_desc)
	Constructor.
virtual	~Ogre2Heightmap () override
	Destructor.
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	Init () override
virtual MaterialPtr	Material () const override
	Returns NULL, heightmap materials don't inherit from MaterialPtr.
virtual Ogre::MovableObject *	OgreObject () const override
	Returns the Terra pointer as it is a movable object that must be attached to a regular SceneNode.
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.
Ogre::Terra *	Terra ()
void	UpdateForRender (Ogre::Camera *_activeCamera)
Public Member Functions inherited from BaseHeightmap< Ogre2Geometry >
virtual const HeightmapDescriptor &	Descriptor () override
	Get the immutable heightmap descriptor.
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 Ogre2Geometry
virtual	~Ogre2Geometry ()
	Destructor.
virtual bool	HasParent () const override
	Determine if this Geometry is attached to a Visual.
virtual VisualPtr	Parent () const override
	Get the parent Visual.
Public Member Functions inherited from BaseGeometry< Ogre2Object >
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 Ogre2Object
virtual	~Ogre2Object ()
	Destructor.
virtual ScenePtr	Scene () const override
Public Member Functions inherited from BaseObject
virtual	~BaseObject ()
virtual unsigned int	Id () const override
virtual std::string	Name () const override
virtual void	PostRender () override

Additional Inherited Members
Public Attributes inherited from BaseHeightmap< Ogre2Geometry >
HeightmapDescriptor	descriptor
	Descriptor containing heightmap information.
Protected Member Functions inherited from BaseHeightmap< Ogre2Geometry >
	BaseHeightmap (const HeightmapDescriptor &_desc)
	Constructor.
Protected Member Functions inherited from Ogre2Geometry
	Ogre2Geometry ()
	Constructor.
virtual void	SetParent (Ogre2VisualPtr _parent)
	Set the parent of this ogre geometry.
Protected Member Functions inherited from BaseGeometry< Ogre2Object >
	BaseGeometry ()
Protected Member Functions inherited from Ogre2Object
	Ogre2Object ()
	Constructor.
Protected Member Functions inherited from BaseObject
	BaseObject ()
virtual void	Load ()
Protected Attributes inherited from Ogre2Geometry
Ogre2VisualPtr	parent
	Parent visual.
Protected Attributes inherited from Ogre2Object
Ogre2ScenePtr	scene
	Pointer to the ogre scene.
Protected Attributes inherited from BaseObject
unsigned int	id
std::string	name

Detailed Description

Ogre implementation of a heightmap geometry.

Constructor & Destructor Documentation

Ogre2Heightmap()

Ogre2Heightmap ( const HeightmapDescriptor &  _desc )

explicit

Constructor.

Parameters

[in]

_desc

Parameters describing how a heightmap should be loaded

~Ogre2Heightmap()

virtual ~Ogre2Heightmap ( )

overridevirtual

Destructor.

Member Function Documentation

Destroy()

virtual void Destroy ( )

overridevirtual

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

Reimplemented from BaseHeightmap< Ogre2Geometry >.

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 the Terra pointer as it is a movable object that must be attached to a regular SceneNode.

Remarks

This behavior is different from ogre1

Returns

Terra pointer

Implements Ogre2Geometry.

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

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.

Terra()

Ogre::Terra * Terra

(

)

UpdateForRender()

void UpdateForRender

(

Ogre::Camera *

_activeCamera

)

---

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

• Ogre2Heightmap.hh