tesseract_visualization::Marker Class Reference

#include <marker.h>

Inheritance diagram for tesseract_visualization::Marker:

Collaboration diagram for tesseract_visualization::Marker:

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

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

Protected Attributes
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...
int	layer_ { 0 }
	The layer of the marker. More...
Eigen::Vector3d	scale_ { Eigen::Vector3d(1, 1, 1) }
	The marker scale. More...

Member Typedef Documentation

ConstPtr

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

Ptr

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

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

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

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

getScale()

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

virtual

Get the marker scale.

Returns

The scale of the marker

getType()

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

pure virtual

Get the marker type.

Returns

The type of the marker

Implemented in tesseract_visualization::ArrowMarker, tesseract_visualization::AxisMarker, tesseract_visualization::ContactResultsMarker, tesseract_visualization::GeometryMarker, and tesseract_visualization::ToolpathMarker.

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

layer

Layer at which the marker will reside

setLifetime()

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

virtual

Set the lifetime of the this marker.

Parameters

lifetime

The time at which the marker will be removed

setParentLink()

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

virtual

The parent link name the marker should be attached to.

Parameters

parent_link

The parent link name

setScale()

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

virtual

Set the marker scale.

Parameters

scale

The marker scale

Member Data Documentation

layer_

int tesseract_visualization::Marker::layer_ { 0 }

protected

The layer of the marker.

lifetime_

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

protected

The lifetime of this Marker.

parent_link_

std::string tesseract_visualization::Marker::parent_link_

protected

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

scale_

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

protected

The marker scale.

---

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

• tesseract_visualization/include/tesseract_visualization/markers/marker.h
• tesseract_visualization/src/markers/marker.cpp