tesseract_visualization::Visualization Class Reference

The Vizualization class. More...

#include <visualization.h>

Inheritance diagram for tesseract_visualization::Visualization:

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

Public Member Functions
	Visualization ()=default
virtual	~Visualization ()=default
	Visualization (const Visualization &)=default
Visualization &	operator= (const Visualization &)=default
	Visualization (Visualization &&)=default
Visualization &	operator= (Visualization &&)=default
virtual bool	isConnected () const =0
	Some plotters may require connecting to external software. More...
virtual void	waitForConnection (long seconds=0) const =0
	Wait for connection. More...
virtual void	plotEnvironment (const tesseract_environment::Environment &env, std::string ns="")=0
	Plot environment. More...
virtual void	plotEnvironmentState (const tesseract_scene_graph::SceneState &state, std::string ns="")=0
	Plot state of the environment. More...
virtual void	plotTrajectory (const tesseract_common::JointTrajectory &traj, const tesseract_scene_graph::StateSolver &state_solver, std::string ns="")=0
	Plot a JointTrajectory. More...
virtual void	plotMarker (const Marker &marker, std::string ns="")=0
	Plot marker. More...
virtual void	plotMarkers (const std::vector< Marker::Ptr > &markers, std::string ns="")=0
	Plot a vector of markers under a given namespace. More...
virtual void	clear (std::string ns="")=0
	This is called at the start of the plotting for each iteration to clear previous iteration graphics if necessary. More...
virtual void	waitForInput (std::string message="Hit enter key to continue!")=0
	Pause code and wait for enter key in terminal. More...

Detailed Description

The Vizualization class.

Member Typedef Documentation

ConstPtr

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

Ptr

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

Constructor & Destructor Documentation

Visualization() [1/3]

tesseract_visualization::Visualization::Visualization ( )

default

~Visualization()

virtual tesseract_visualization::Visualization::~Visualization ( )

virtualdefault

Visualization() [2/3]

tesseract_visualization::Visualization::Visualization ( const Visualization &  )

default

Visualization() [3/3]

tesseract_visualization::Visualization::Visualization ( Visualization &&  )

default

Member Function Documentation

clear()

virtual void tesseract_visualization::Visualization::clear ( std::string  ns = "" )

pure virtual

This is called at the start of the plotting for each iteration to clear previous iteration graphics if necessary.

Implemented in tesseract_visualization::TesseractIgnitionVisualization.

isConnected()

virtual bool tesseract_visualization::Visualization::isConnected ( ) const

pure virtual

Some plotters may require connecting to external software.

Returns

True if connected, otherwise false

Implemented in tesseract_visualization::TesseractIgnitionVisualization.

operator=() [1/2]

Visualization & tesseract_visualization::Visualization::operator= ( const Visualization &  )

default

operator=() [2/2]

Visualization & tesseract_visualization::Visualization::operator= ( Visualization &&  )

default

plotEnvironment()

virtual void tesseract_visualization::Visualization::plotEnvironment ( const tesseract_environment::Environment &  env, std::string  ns = ""  )

pure virtual

Plot environment.

Parameters

env	The environment.

Implemented in tesseract_visualization::TesseractIgnitionVisualization.

plotEnvironmentState()

virtual void tesseract_visualization::Visualization::plotEnvironmentState ( const tesseract_scene_graph::SceneState &  state, std::string  ns = ""  )

pure virtual

Plot state of the environment.

Parameters

state

The state of the environment.

Implemented in tesseract_visualization::TesseractIgnitionVisualization.

plotMarker()

virtual void tesseract_visualization::Visualization::plotMarker ( const Marker &  marker, std::string  ns = ""  )

pure virtual

Plot marker.

Parameters

marker	The marker to plot
ns	The namespace to plot the object under

Implemented in tesseract_visualization::TesseractIgnitionVisualization.

plotMarkers()

virtual void tesseract_visualization::Visualization::plotMarkers ( const std::vector< Marker::Ptr > &  markers, std::string  ns = ""  )

pure virtual

Plot a vector of markers under a given namespace.

Parameters

markers	The markers to plot
ns	The namespace to plot the objects under

Implemented in tesseract_visualization::TesseractIgnitionVisualization.

plotTrajectory()

virtual void tesseract_visualization::Visualization::plotTrajectory ( const tesseract_common::JointTrajectory &  traj, const tesseract_scene_graph::StateSolver &  state_solver, std::string  ns = ""  )

pure virtual

Plot a JointTrajectory.

Parameters

state_solver	The environment
trajectory	JointTrajectory to be plotted

Implemented in tesseract_visualization::TesseractIgnitionVisualization.

waitForConnection()

virtual void tesseract_visualization::Visualization::waitForConnection ( long  seconds = 0 ) const

pure virtual

Wait for connection.

Parameters

seconds

The number of seconds to wait before returning, if zero it waits indefinitely

Implemented in tesseract_visualization::TesseractIgnitionVisualization.

waitForInput()

virtual void tesseract_visualization::Visualization::waitForInput ( std::string  message = "Hit enter key to continue!" )

pure virtual

Pause code and wait for enter key in terminal.

Implemented in tesseract_visualization::TesseractIgnitionVisualization.

---

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

• tesseract_visualization/include/tesseract_visualization/visualization.h