Gazebo Rendering

API Reference

6.6.3

Ogre2.x implementation of the geometry class. More...

#include <Ogre2Geometry.hh>

Public Member Functions

virtual ~Ogre2Geometry ()
 Destructor. More...
 
virtual bool HasParent () const override
 Determine if this Geometry is attached to a Visual. More...
 
virtual Ogre::MovableObject * OgreObject () const =0
 Get the ogre object representing this geometry. More...
 
virtual VisualPtr Parent () const override
 Get the parent Visual. More...
 
- Public Member Functions inherited from BaseGeometry< Ogre2Object >
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 GeometryPtr Clone () const =0
 Clone the geometry. 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...
 
- Public Member Functions inherited from Ogre2Object
virtual ~Ogre2Object ()
 Destructor. More...
 
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
 
virtual void PreRender () override
 

Protected Member Functions

 Ogre2Geometry ()
 Constructor. More...
 
virtual void SetParent (Ogre2VisualPtr _parent)
 Set the parent of this ogre geometry. More...
 
- Protected Member Functions inherited from BaseGeometry< Ogre2Object >
 BaseGeometry ()
 
- Protected Member Functions inherited from Ogre2Object
 Ogre2Object ()
 Constructor. More...
 
- Protected Member Functions inherited from BaseObject
 BaseObject ()
 
virtual void Init ()
 
virtual void Load ()
 

Protected Attributes

Ogre2VisualPtr parent
 Parent visual. More...
 
- Protected Attributes inherited from Ogre2Object
Ogre2ScenePtr scene
 Pointer to the ogre scene. More...
 
- Protected Attributes inherited from BaseObject
unsigned int id
 
std::string name
 

Detailed Description

Ogre2.x implementation of the geometry class.

Constructor & Destructor Documentation

◆ Ogre2Geometry()

Ogre2Geometry ( )
protected

Constructor.

◆ ~Ogre2Geometry()

virtual ~Ogre2Geometry ( )
virtual

Destructor.

Member Function Documentation

◆ HasParent()

virtual bool HasParent ( ) const
overridevirtual

Determine if this Geometry is attached to a Visual.

Returns
True if this Geometry has a parent Visual

Implements Geometry.

◆ OgreObject()

virtual Ogre::MovableObject* OgreObject ( ) const
pure virtual

Get the ogre object representing this geometry.

Returns
Pointer to an ogre movable object

Implemented in Ogre2Mesh, Ogre2Heightmap, Ogre2Capsule, Ogre2Marker, Ogre2WireBox, and Ogre2Grid.

◆ Parent()

virtual VisualPtr Parent ( ) const
overridevirtual

Get the parent Visual.

Returns
the parent Visual

Implements Geometry.

◆ SetParent()

virtual void SetParent ( Ogre2VisualPtr  _parent)
protectedvirtual

Set the parent of this ogre geometry.

Parameters
[in]_parentParent visual

Member Data Documentation

◆ parent

Ogre2VisualPtr parent
protected

Parent visual.


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