Base implementation of a Marker geometry. More...
#include <BaseMarker.hh>
Public Member Functions | |
virtual | ~BaseMarker () |
Destructor. More... | |
virtual void | AddPoint (double _x, double _y, double _z, const ignition::math::Color &_color) override |
Add a point with its respective color to the marker. More... | |
virtual void | AddPoint (const ignition::math::Vector3d &_pt, const ignition::math::Color &_color) override |
Add a point with its respective color to the marker. More... | |
virtual void | ClearPoints () override |
Clear the points of the marker, if applicable. More... | |
virtual void | Destroy () override |
Destroy function. More... | |
virtual int32_t | Layer () const override |
Get the layer of this Marker. More... | |
virtual std::chrono::steady_clock::duration | Lifetime () const override |
Get the lifetime of this Marker. More... | |
virtual void | PreRender () override |
PreRender function. More... | |
virtual void | SetLayer (int32_t _layer) override |
Set the layer of this Marker. More... | |
virtual void | SetLifetime (const std::chrono::steady_clock::duration &_lifetime) override |
Set the lifetime of this Marker. More... | |
virtual void | SetPoint (unsigned int _index, const ignition::math::Vector3d &_value) override |
Set an existing point's vector. More... | |
virtual void | SetType (const MarkerType _markerType) override |
Set the render type of this Marker. More... | |
virtual MarkerType | Type () const override |
Get the render type of this Marker. More... | |
Public Member Functions inherited from Marker | |
virtual | ~Marker () |
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 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 ScenePtr | Scene () const =0 |
Get the Scene that created this object. More... | |
Protected Member Functions | |
BaseMarker () | |
Constructor. More... | |
Protected Member Functions inherited from Marker | |
Marker () | |
Protected Attributes | |
int32_t | layer = 0 |
Layer at which the marker will reside. More... | |
std::chrono::steady_clock::duration | lifetime |
Life time of a marker. More... | |
bool | markerDirty = false |
Flag to indicate if marker needs to be updated. More... | |
MarkerType | markerType |
Marker type. More... | |
Detailed Description
template<class T>
class ignition::rendering::BaseMarker< T >
Base implementation of a Marker geometry.
Constructor & Destructor Documentation
◆ BaseMarker()
|
protected |
Constructor.
◆ ~BaseMarker()
|
virtual |
Destructor.
Member Function Documentation
◆ AddPoint() [1/2]
|
overridevirtual |
Add a point with its respective color to the marker.
- Parameters
-
[in] _x X coordinate [in] _y Y coordinate [in] _z Z coordinate [in] _color The color the point is set to
Implements Marker.
Referenced by BaseMarker< OgreGeometry >::AddPoint().
◆ AddPoint() [2/2]
|
overridevirtual |
Add a point with its respective color to the marker.
- Parameters
-
[in] _pt A vector containing the position of the point [in] _color The color the point is set to
Implements Marker.
Reimplemented in OgreMarker, and Ogre2Marker.
◆ ClearPoints()
|
overridevirtual |
Clear the points of the marker, if applicable.
Implements Marker.
Reimplemented in OgreMarker, and Ogre2Marker.
◆ Destroy()
|
overridevirtual |
◆ Layer()
|
overridevirtual |
◆ Lifetime()
|
overridevirtual |
◆ PreRender()
|
overridevirtual |
◆ SetLayer()
|
overridevirtual |
◆ SetLifetime()
|
overridevirtual |
◆ SetPoint()
|
overridevirtual |
Set an existing point's vector.
- Parameters
-
[in] _index The index of the point [in] _value The new positional vector of the point
Implements Marker.
Reimplemented in OgreMarker, and Ogre2Marker.
◆ SetType()
|
overridevirtual |
Set the render type of this Marker.
- Parameters
-
[in] The desired render type
Implements Marker.
Reimplemented in OgreMarker, and Ogre2Marker.
◆ Type()
|
overridevirtual |
Get the render type of this Marker.
- Returns
- The render type of the marker
Implements Marker.
Reimplemented in OgreMarker, and Ogre2Marker.
Member Data Documentation
◆ layer
|
protected |
Layer at which the marker will reside.
Referenced by BaseMarker< OgreGeometry >::Layer(), and BaseMarker< OgreGeometry >::SetLayer().
◆ lifetime
|
protected |
Life time of a marker.
Referenced by BaseMarker< OgreGeometry >::Lifetime(), and BaseMarker< OgreGeometry >::SetLifetime().
◆ markerDirty
|
protected |
Flag to indicate if marker needs to be updated.
Referenced by BaseMarker< OgreGeometry >::SetLayer(), BaseMarker< OgreGeometry >::SetLifetime(), and BaseMarker< OgreGeometry >::SetType().
◆ markerType
|
protected |
Marker type.
Referenced by BaseMarker< OgreGeometry >::SetType(), and BaseMarker< OgreGeometry >::Type().
The documentation for this class was generated from the following file: