Gazebo Rendering

API Reference

6.6.3

#include <BaseHeightmap.hh>

Public Member Functions

virtual const HeightmapDescriptorDescriptor () 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 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...
 
- Public Member Functions inherited from Geometry
virtual ~Geometry ()
 Deconstructor. More...
 
virtual GeometryPtr Clone () const =0
 Clone the geometry. More...
 
virtual bool HasParent () const =0
 Determine if this Geometry is attached to a Visual. More...
 
virtual MaterialPtr Material () const =0
 Get the material of this geometry. More...
 
virtual VisualPtr Parent () const =0
 Get the parent Visual. More...
 
virtual void RemoveParent ()=0
 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 &_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. More...
 
virtual void SetMaterial (MaterialPtr _material, bool _unique=true)=0
 Set the materials of this Geometry. More...
 
- Public Member Functions inherited from Object
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...
 

Public Attributes

HeightmapDescriptor descriptor
 Descriptor containing heightmap information. More...
 

Protected Member Functions

 BaseHeightmap (const HeightmapDescriptor &_desc)
 Constructor. More...
 

Constructor & Destructor Documentation

◆ BaseHeightmap()

BaseHeightmap ( const HeightmapDescriptor _desc)
explicitprotected

Constructor.

Parameters
[in]_descDescriptor containing heightmap information.

Member Function Documentation

◆ Descriptor()

const HeightmapDescriptor & Descriptor ( )
overridevirtual

Get the immutable heightmap descriptor.

Returns
Descriptor with heightmap information.

Implements Heightmap.

◆ Destroy()

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.

◆ PreRender()

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 Ogre2Heightmap, and OgreHeightmap.

Member Data Documentation

◆ descriptor

HeightmapDescriptor descriptor

Descriptor containing heightmap information.


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