Gazebo Rendering

API Reference

7.4.2
Capsule Class Referenceabstract

Geometry for a capsule shape. The APIs allow setting the capsule's radius and length directly which ensure that the the geometry remains the shape of a capsule. In comparison, if the size is changed via the parent Node's Set*Scale function, the capsule may become deformed. More...

#include <gz/rendering/Capsule>

Public Member Functions

virtual ~Capsule ()
 Destructor. More...
 
virtual double Length () const =0
 Get the length of the capsule. More...
 
virtual double Radius () const =0
 Get the radius of the capsule. More...
 
virtual void SetLength (double _length)=0
 Set the length of the capsule. More...
 
virtual void SetRadius (double _radius)=0
 Set the radius of the capsule. More...
 
- Public Member Functions inherited from Geometry
virtual ~Geometry ()
 Destructor. 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 void Destroy ()=0
 Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior. 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...
 

Detailed Description

Geometry for a capsule shape. The APIs allow setting the capsule's radius and length directly which ensure that the the geometry remains the shape of a capsule. In comparison, if the size is changed via the parent Node's Set*Scale function, the capsule may become deformed.

Constructor & Destructor Documentation

◆ ~Capsule()

virtual ~Capsule ( )
virtual

Destructor.

Member Function Documentation

◆ Length()

virtual double Length ( ) const
pure virtual

Get the length of the capsule.

Implemented in BaseCapsule< T >.

◆ Radius()

virtual double Radius ( ) const
pure virtual

Get the radius of the capsule.

Implemented in BaseCapsule< T >.

◆ SetLength()

virtual void SetLength ( double  _length)
pure virtual

Set the length of the capsule.

Implemented in BaseCapsule< T >, BaseCapsule< Ogre2Geometry >, and BaseCapsule< OgreGeometry >.

◆ SetRadius()

virtual void SetRadius ( double  _radius)
pure virtual

Set the radius of the capsule.

Implemented in BaseCapsule< T >, BaseCapsule< Ogre2Geometry >, and BaseCapsule< OgreGeometry >.


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