BaseCapsule< T > Class Template Reference
Base implementation of a Capsule Geometry. More...
#include <BaseCapsule.hh>
Public Member Functions | |
| 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. | |
| virtual bool | HasParent () const =0 |
| Determine if this Geometry is attached to a Visual. | |
| virtual MaterialPtr | Material () const =0 |
| Get the material of this geometry. | |
| virtual VisualPtr | Parent () const =0 |
| Get the parent Visual. | |
| virtual void | RemoveParent ()=0 |
| 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 &_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. | |
| virtual void | SetMaterial (MaterialPtr _material, bool _unique=true)=0 |
| Set the materials of this Geometry. | |
| Public Member Functions inherited from Object | |
| virtual | ~Object () |
| Destructor. | |
| virtual void | Destroy ()=0 |
| Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior. | |
| 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 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. | |
| virtual ScenePtr | Scene () const =0 |
| Get the Scene that created this object. | |
Protected Member Functions | |
| BaseCapsule () | |
Protected Attributes | |
| bool | capsuleDirty = false |
| Flag to indicate capsule properties have changed. | |
| double | length = 0.5 |
| Length of the capsule. | |
| double | radius = 0.5 |
| Radius of the capsule. | |
Detailed Description
Constructor & Destructor Documentation
◆ BaseCapsule()
template<class T >
|
protected |
◆ ~BaseCapsule()
template<class T >
|
virtual |
Member Function Documentation
◆ Clone()
template<class T >
|
overridevirtual |
Clone the geometry.
- Returns
- The cloned geometry.
Implements Geometry.
References Scene::CreateCapsule(), and gzerr.
◆ Length()
template<class T >
|
overridevirtual |
Get the length of the capsule.
Implements Capsule.
◆ Radius()
template<class T >
|
overridevirtual |
Get the radius of the capsule.
Implements Capsule.
◆ SetLength()
template<class T >
|
overridevirtual |
Set the length of the capsule.
Implements Capsule.
◆ SetRadius()
template<class T >
|
overridevirtual |
Set the radius of the capsule.
Implements Capsule.
Member Data Documentation
◆ capsuleDirty
template<class T >
|
protected |
Flag to indicate capsule properties have changed.
◆ length
template<class T >
|
protected |
Length of the capsule.
◆ radius
template<class T >
|
protected |
Radius of the capsule.
The documentation for this class was generated from the following file: