Gazebo Rendering

API Reference

6.6.3
BaseGeometry< T > Class Template Referenceabstract

#include <BaseGeometry.hh>

Public Member Functions

virtual ~BaseGeometry ()
 
virtual GeometryPtr Clone () const override
 Clone the geometry. 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 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 void SetMaterial (MaterialPtr _material, bool _unique=true) override=0
 Set the materials of this Geometry. More...
 
- Public Member Functions inherited from Geometry
virtual ~Geometry ()
 Deconstructor. 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...
 
- 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 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. More...
 
virtual ScenePtr Scene () const =0
 Get the Scene that created this object. More...
 

Protected Member Functions

 BaseGeometry ()
 

Constructor & Destructor Documentation

◆ BaseGeometry()

BaseGeometry
protected

◆ ~BaseGeometry()

~BaseGeometry
virtual

Member Function Documentation

◆ Clone()

GeometryPtr Clone ( ) const
overridevirtual

Clone the geometry.

Returns
The cloned geometry.

Implements Geometry.

Reimplemented in BaseMesh< Ogre2Geometry >, BaseMesh< OgreGeometry >, BaseCapsule< Ogre2Geometry >, and BaseCapsule< OgreGeometry >.

◆ Destroy()

void Destroy ( )
overridevirtual

◆ Parent()

virtual VisualPtr Parent ( ) const
overridepure virtual

Get the parent Visual.

Returns
the parent Visual

Implements Geometry.

◆ RemoveParent()

void RemoveParent ( )
overridevirtual

Detach this Geometry from its parent Visual. If this Geometry does not have a parent, no work will be done.

Implements Geometry.

◆ SetMaterial() [1/2]

void SetMaterial ( const std::string _name,
bool  _unique = true 
)
overridevirtual

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.

Parameters
[in]_nameName of registered Material
[in]_uniqueTrue if the specified material should be cloned

Implements Geometry.

Reimplemented in BaseMesh< Ogre2Geometry >, and BaseMesh< OgreGeometry >.

◆ SetMaterial() [2/2]

virtual void SetMaterial ( MaterialPtr  _material,
bool  _unique = true 
)
overridepure virtual

Set the materials of this Geometry.

Parameters
[in]_materialNew Material to be assigned
[in]_uniqueTrue if the given material should be cloned

Implements Geometry.

Implemented in BaseMesh< Ogre2Geometry >, BaseMesh< OgreGeometry >, Ogre2Heightmap, OgreHeightmap, Ogre2Capsule, OgreCapsule, OgreText, OgreWireBox, Ogre2WireBox, OgreMarker, Ogre2Marker, OgreGrid, and Ogre2Grid.


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