Tesseract 0.28.4
Loading...
Searching...
No Matches
tesseract::visualization::Visualization Class Referenceabstract

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 (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.
virtual void waitForConnection (long seconds=0) const =0
 Wait for connection.
virtual void plotEnvironment (const tesseract::environment::Environment &env, std::string ns="")=0
 Plot environment.
virtual void plotEnvironmentState (const tesseract::scene_graph::SceneState &state, std::string ns="")=0
 Plot state of the environment.
virtual void plotTrajectory (const tesseract::common::JointTrajectory &traj, const tesseract::scene_graph::StateSolver &state_solver, std::string ns="")=0
 Plot a JointTrajectory.
virtual void plotMarker (const Marker &marker, std::string ns="")=0
 Plot marker.
virtual void plotMarkers (const std::vector< std::shared_ptr< Marker > > &markers, std::string ns="")=0
 Plot a vector of markers under a given namespace.
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.
virtual void waitForInput (std::string message="Hit enter key to continue!")=0
 Pause code and wait for enter key in terminal.

Detailed Description

The Vizualization class.

Member Function Documentation

◆ isConnected()

virtual bool tesseract::visualization::Visualization::isConnected ( ) const
pure virtual

Some plotters may require connecting to external software.

Returns
True if connected, otherwise false

◆ waitForConnection()

virtual void tesseract::visualization::Visualization::waitForConnection ( long seconds = 0) const
pure virtual

Wait for connection.

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

◆ plotEnvironment()

virtual void tesseract::visualization::Visualization::plotEnvironment ( const tesseract::environment::Environment & env,
std::string ns = "" )
pure virtual

Plot environment.

Parameters
envThe environment.

◆ plotEnvironmentState()

virtual void tesseract::visualization::Visualization::plotEnvironmentState ( const tesseract::scene_graph::SceneState & state,
std::string ns = "" )
pure virtual

Plot state of the environment.

Parameters
stateThe state of the environment.

◆ 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_solverThe environment
trajectoryJointTrajectory to be plotted

◆ plotMarker()

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

Plot marker.

Parameters
markerThe marker to plot
nsThe namespace to plot the object under

◆ plotMarkers()

virtual void tesseract::visualization::Visualization::plotMarkers ( const std::vector< std::shared_ptr< Marker > > & markers,
std::string ns = "" )
pure virtual

Plot a vector of markers under a given namespace.

Parameters
markersThe markers to plot
nsThe namespace to plot the objects under