Public Types | Public Member Functions | Protected Attributes | List of all members
tesseract_visualization::Marker Class Referenceabstract

#include <marker.h>

Inheritance diagram for tesseract_visualization::Marker:
Inheritance graph
[legend]

Public Types

using ConstPtr = std::shared_ptr< const Marker >
 
using Ptr = std::shared_ptr< Marker >
 

Public Member Functions

virtual int getLayer () const
 Get the layer of this Marker. More...
 
virtual std::chrono::steady_clock::duration getLifetime () const
 Get the lifetime of this Marker. More...
 
virtual const std::string & getParentLink () const
 Get the parent link name that marker should be attached to. More...
 
virtual const Eigen::Vector3dgetScale () const
 Get the marker scale. More...
 
virtual int getType () const =0
 Get the marker type. More...
 
 Marker ()=default
 
 Marker (const Marker &)=default
 
 Marker (Marker &&)=default
 
Markeroperator= (const Marker &)=default
 
Markeroperator= (Marker &&)=default
 
virtual void setLayer (int layer)
 Set the layer of this Marker. More...
 
virtual void setLifetime (const std::chrono::steady_clock::duration &lifetime)
 Set the lifetime of the this marker. More...
 
virtual void setParentLink (std::string parent_link)
 The parent link name the marker should be attached to. More...
 
virtual void setScale (const Eigen::Vector3d &scale)
 Set the marker scale. More...
 
virtual ~Marker ()=default
 

Protected Attributes

int layer_ { 0 }
 The layer of the marker. More...
 
std::chrono::steady_clock::duration lifetime_ { 0 }
 The lifetime of this Marker. More...
 
std::string parent_link_
 The parent link the marker is attched to. If empty relative to world. More...
 
Eigen::Vector3d scale_ { Eigen::Vector3d(1, 1, 1) }
 The marker scale. More...
 

Detailed Description

Definition at line 74 of file marker.h.

Member Typedef Documentation

◆ ConstPtr

using tesseract_visualization::Marker::ConstPtr = std::shared_ptr<const Marker>

Definition at line 80 of file marker.h.

◆ Ptr

using tesseract_visualization::Marker::Ptr = std::shared_ptr<Marker>

Definition at line 79 of file marker.h.

Constructor & Destructor Documentation

◆ Marker() [1/3]

tesseract_visualization::Marker::Marker ( )
default

◆ ~Marker()

virtual tesseract_visualization::Marker::~Marker ( )
virtualdefault

◆ Marker() [2/3]

tesseract_visualization::Marker::Marker ( const Marker )
default

◆ Marker() [3/3]

tesseract_visualization::Marker::Marker ( Marker &&  )
default

Member Function Documentation

◆ getLayer()

int tesseract_visualization::Marker::getLayer ( ) const
virtual

Get the layer of this Marker.

Returns
The layer of the marker

Definition at line 16 of file marker.cpp.

◆ getLifetime()

std::chrono::steady_clock::duration tesseract_visualization::Marker::getLifetime ( ) const
virtual

Get the lifetime of this Marker.

Returns
The time at which the marker will be removed

Definition at line 12 of file marker.cpp.

◆ getParentLink()

const std::string & tesseract_visualization::Marker::getParentLink ( ) const
virtual

Get the parent link name that marker should be attached to.

If empty then it should be relative world coordinates

Definition at line 8 of file marker.cpp.

◆ getScale()

const Eigen::Vector3d & tesseract_visualization::Marker::getScale ( ) const
virtual

Get the marker scale.

Returns
The scale of the marker

Definition at line 20 of file marker.cpp.

◆ getType()

virtual int tesseract_visualization::Marker::getType ( ) const
pure virtual

◆ operator=() [1/2]

Marker& tesseract_visualization::Marker::operator= ( const Marker )
default

◆ operator=() [2/2]

Marker& tesseract_visualization::Marker::operator= ( Marker &&  )
default

◆ setLayer()

void tesseract_visualization::Marker::setLayer ( int  layer)
virtual

Set the layer of this Marker.

Parameters
layerLayer at which the marker will reside

Definition at line 14 of file marker.cpp.

◆ setLifetime()

void tesseract_visualization::Marker::setLifetime ( const std::chrono::steady_clock::duration lifetime)
virtual

Set the lifetime of the this marker.

Parameters
lifetimeThe time at which the marker will be removed

Definition at line 10 of file marker.cpp.

◆ setParentLink()

void tesseract_visualization::Marker::setParentLink ( std::string  parent_link)
virtual

The parent link name the marker should be attached to.

Parameters
parent_linkThe parent link name

Definition at line 6 of file marker.cpp.

◆ setScale()

void tesseract_visualization::Marker::setScale ( const Eigen::Vector3d scale)
virtual

Set the marker scale.

Parameters
scaleThe marker scale

Definition at line 18 of file marker.cpp.

Member Data Documentation

◆ layer_

int tesseract_visualization::Marker::layer_ { 0 }
protected

The layer of the marker.

Definition at line 151 of file marker.h.

◆ lifetime_

std::chrono::steady_clock::duration tesseract_visualization::Marker::lifetime_ { 0 }
protected

The lifetime of this Marker.

Definition at line 145 of file marker.h.

◆ parent_link_

std::string tesseract_visualization::Marker::parent_link_
protected

The parent link the marker is attched to. If empty relative to world.

Definition at line 148 of file marker.h.

◆ scale_

Eigen::Vector3d tesseract_visualization::Marker::scale_ { Eigen::Vector3d(1, 1, 1) }
protected

The marker scale.

Definition at line 154 of file marker.h.


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


tesseract_visualization
Author(s): Levi Armstrong
autogenerated on Sun May 18 2025 03:02:27