Ignition Rendering

API Reference

5.1.0

Base implementation of a Capsule Geometry. More...

#include <BaseCapsule.hh>

Public Member Functions

virtual ~BaseCapsule ()
 
virtual double Length () const override
 Get the length of the capsule. More...
 
virtual double Radius () const override
 Get the radius of the capsule. More...
 
virtual void SetLength (double _length) override
 Set the length of the capsule. More...
 
virtual void SetRadius (double _radius) override
 Set the radius of the capsule. More...
 
- Public Member Functions inherited from Capsule
virtual ~Capsule ()
 Destructor. More...
 
- Public Member Functions inherited from Geometry
virtual ~Geometry ()
 Destructor. 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...
 

Protected Member Functions

 BaseCapsule ()
 

Protected Attributes

bool capsuleDirty = false
 Flag to indicate capsule properties have changed. More...
 
double length = 0.5
 Length of the capsule. More...
 
double radius = 0.5
 Radius of the capsule. More...
 

Detailed Description

template<class T>
class ignition::rendering::BaseCapsule< T >

Base implementation of a Capsule Geometry.

Constructor & Destructor Documentation

◆ BaseCapsule()

BaseCapsule ( )
protected

◆ ~BaseCapsule()

~BaseCapsule ( )
virtual

Member Function Documentation

◆ Length()

double Length ( ) const
overridevirtual

Get the length of the capsule.

Implements Capsule.

◆ Radius()

double Radius ( ) const
overridevirtual

Get the radius of the capsule.

Implements Capsule.

◆ SetLength()

void SetLength ( double  _length)
overridevirtual

Set the length of the capsule.

Implements Capsule.

◆ SetRadius()

void SetRadius ( double  _radius)
overridevirtual

Set the radius of the capsule.

Implements Capsule.

Member Data Documentation

◆ capsuleDirty

bool capsuleDirty = false
protected

Flag to indicate capsule properties have changed.

Referenced by BaseCapsule< OgreGeometry >::SetLength(), and BaseCapsule< OgreGeometry >::SetRadius().

◆ length

double length = 0.5
protected

◆ radius

double radius = 0.5
protected

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