Ogre2Heightmap Class Reference
Ogre implementation of a heightmap geometry. More...
#include <Ogre2Heightmap.hh>
Public Member Functions | |
Ogre2Heightmap (const HeightmapDescriptor &_desc) | |
Constructor. More... | |
virtual | ~Ogre2Heightmap () override |
Destructor. More... | |
virtual void | Init () override |
virtual MaterialPtr | Material () const override |
Returns NULL, heightmap materials don't inherit from MaterialPtr. More... | |
virtual Ogre::MovableObject * | OgreObject () const override |
Returns the Terra pointer as it is a movable object that must be attached to a regular SceneNode. More... | |
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. More... | |
virtual void | SetMaterial (MaterialPtr _material, bool _unique) override |
Has no effect for heightmaps. The material is set through a HeightmapDescriptor. More... | |
Ogre::Terra * | Terra () |
void | UpdateForRender (Ogre::Camera *_activeCamera) |
![]() | |
virtual const HeightmapDescriptor & | Descriptor () override |
Get the immutable heightmap descriptor. More... | |
virtual void | Destroy () override |
Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior. More... | |
![]() | |
virtual | ~Geometry () |
Destructor. More... | |
virtual GeometryPtr | Clone () const =0 |
Clone the geometry. More... | |
![]() | |
virtual | ~Object () |
Destructor. More... | |
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. More... | |
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. More... | |
virtual void | PostRender ()=0 |
Post process this object and any of its children after rendering. More... | |
virtual ScenePtr | Scene () const =0 |
Get the Scene that created this object. More... | |
![]() | |
virtual | ~Ogre2Geometry () |
Destructor. More... | |
virtual bool | HasParent () const override |
Determine if this Geometry is attached to a Visual. More... | |
virtual VisualPtr | Parent () const override |
Get the parent Visual. More... | |
![]() | |
virtual | ~BaseGeometry () |
virtual GeometryPtr | Clone () const override |
Clone the geometry. More... | |
virtual VisualPtr | Parent () const override=0 |
Get the parent Visual. More... | |
virtual void | RemoveParent () override |
Detach this Geometry from its parent Visual. If this Geometry does not have a parent, no work will be done. More... | |
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. More... | |
![]() | |
virtual | ~Ogre2Object () |
Destructor. More... | |
virtual ScenePtr | Scene () const override |
![]() | |
virtual | ~BaseObject () |
virtual unsigned int | Id () const override |
virtual std::string | Name () const override |
virtual void | PostRender () override |
Additional Inherited Members | |
![]() | |
HeightmapDescriptor | descriptor |
Descriptor containing heightmap information. More... | |
![]() | |
BaseHeightmap (const HeightmapDescriptor &_desc) | |
Constructor. More... | |
![]() | |
Ogre2Geometry () | |
Constructor. More... | |
virtual void | SetParent (Ogre2VisualPtr _parent) |
Set the parent of this ogre geometry. More... | |
![]() | |
BaseGeometry () | |
![]() | |
Ogre2Object () | |
Constructor. More... | |
![]() | |
BaseObject () | |
virtual void | Load () |
![]() | |
Ogre2VisualPtr | parent |
Parent visual. More... | |
![]() | |
Ogre2ScenePtr | scene |
Pointer to the ogre scene. More... | |
![]() | |
unsigned int | id |
std::string | name |
Detailed Description
Ogre implementation of a heightmap geometry.
Constructor & Destructor Documentation
◆ Ogre2Heightmap()
|
explicit |
Constructor.
- Parameters
-
[in] _desc Parameters describing how a heightmap should be loaded
◆ ~Ogre2Heightmap()
|
overridevirtual |
Destructor.
Member Function Documentation
◆ Init()
|
overridevirtual |
Reimplemented from BaseObject.
◆ Material()
|
overridevirtual |
Returns NULL, heightmap materials don't inherit from MaterialPtr.
- Returns
- Null pointer.
Implements Geometry.
◆ OgreObject()
|
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()
|
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()
|
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: