Gazebo Rendering

API Reference

10.0.0
List of all members | Public Member Functions | Protected Member Functions
OgreCapsule Class Reference

Ogre 2.x implementation of a Capsule Visual. More...

#include <OgreCapsule.hh>

Public Member Functions

virtual ~OgreCapsule ()
 Destructor.
 
virtual void Destroy () override
 Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior.
 
virtual void Init () override
 
virtual MaterialPtr Material () const override
 Get the material of this geometry.
 
virtual Ogre::MovableObject * OgreObject () const override
 
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.
 
virtual void SetMaterial (MaterialPtr _material, bool _unique) override
 Set the materials of this Geometry.
 
- Public Member Functions inherited from BaseCapsule< OgreGeometry >
virtual ~BaseCapsule ()
 
virtual GeometryPtr Clone () const override
 Clone the geometry.
 
virtual double Length () const override
 Get the length of the capsule.
 
virtual double Radius () const override
 Get the radius of the capsule.
 
virtual void SetLength (double _length) override
 Set the length of the capsule.
 
virtual void SetRadius (double _radius) override
 Set the radius of the capsule.
 
- Public Member Functions inherited from Capsule
virtual ~Capsule ()
 Destructor.
 
- Public Member Functions inherited from Geometry
virtual ~Geometry ()
 Destructor.
 
- Public Member Functions inherited from Object
virtual ~Object ()
 Destructor.
 
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 ScenePtr Scene () const =0
 Get the Scene that created this object.
 
- Public Member Functions inherited from OgreGeometry
virtual ~OgreGeometry ()
 
virtual bool HasParent () const
 Determine if this Geometry is attached to a Visual.
 
virtual VisualPtr Parent () const
 Get the parent Visual.
 
- Public Member Functions inherited from BaseGeometry< OgreObject >
virtual ~BaseGeometry ()
 
virtual void RemoveParent () override
 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 &_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.
 
- Public Member Functions inherited from OgreObject
virtual ~OgreObject ()
 
virtual ScenePtr Scene () const
 
- Public Member Functions inherited from BaseObject
virtual ~BaseObject ()
 
virtual unsigned int Id () const override
 
virtual std::string Name () const override
 
virtual void PostRender () override
 

Protected Member Functions

 OgreCapsule ()
 Constructor.
 
- Protected Member Functions inherited from BaseCapsule< OgreGeometry >
 BaseCapsule ()
 
- Protected Member Functions inherited from OgreGeometry
 OgreGeometry ()
 
virtual void SetParent (OgreVisualPtr _parent)
 
- Protected Member Functions inherited from BaseGeometry< OgreObject >
 BaseGeometry ()
 
- Protected Member Functions inherited from OgreObject
 OgreObject ()
 
- Protected Member Functions inherited from BaseObject
 BaseObject ()
 
virtual void Load ()
 

Additional Inherited Members

- Protected Attributes inherited from BaseCapsule< OgreGeometry >
bool capsuleDirty
 Flag to indicate capsule properties have changed.
 
double length
 Length of the capsule.
 
double radius
 Radius of the capsule.
 
- Protected Attributes inherited from OgreGeometry
OgreVisualPtr parent
 
- Protected Attributes inherited from OgreObject
OgreScenePtr scene
 
- Protected Attributes inherited from BaseObject
unsigned int id
 
std::string name
 

Detailed Description

Ogre 2.x implementation of a Capsule Visual.

Constructor & Destructor Documentation

◆ OgreCapsule()

OgreCapsule ( )
protected

Constructor.

◆ ~OgreCapsule()

virtual ~OgreCapsule ( )
virtual

Destructor.

Member Function Documentation

◆ Destroy()

virtual 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.

◆ Init()

virtual void Init ( )
overridevirtual

Reimplemented from BaseObject.

◆ Material()

virtual MaterialPtr Material ( ) const
overridevirtual

Get the material of this geometry.

Returns
Material used by this geometry

Implements Geometry.

◆ OgreObject()

virtual Ogre::MovableObject * OgreObject ( ) const
overridevirtual

Implements OgreGeometry.

◆ PreRender()

virtual 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.

◆ SetMaterial()

virtual void SetMaterial ( MaterialPtr  _material,
bool  _unique 
)
overridevirtual

Set the materials of this Geometry.

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

Implements Geometry.

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