Heightmap Class Referenceabstract
A terrain defined by a heightfield. More...
#include <gz/rendering/Heightmap>
Public Member Functions | |
| virtual const HeightmapDescriptor & | Descriptor ()=0 |
| Get the immutable heightmap descriptor. | |
 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 void | Destroy ()=0 |
| Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior. | |
| 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 void | PreRender ()=0 |
| 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 ScenePtr | Scene () const =0 |
| Get the Scene that created this object. | |
Detailed Description
A terrain defined by a heightfield.
Member Function Documentation
◆ Descriptor()
|
pure virtual |
Get the immutable heightmap descriptor.
- Returns
- Descriptor with heightmap information.
Implemented in BaseHeightmap< T >, BaseHeightmap< Ogre2Geometry >, and BaseHeightmap< OgreGeometry >.
The documentation for this class was generated from the following file: