visualization.h
Go to the documentation of this file.
1 
26 #ifndef TESSERACT_VISUALIZATION_VISUALIZATION_H
27 #define TESSERACT_VISUALIZATION_VISUALIZATION_H
28 
31 #include <memory>
32 #include <vector>
33 #include <string>
35 
36 #include <tesseract_common/fwd.h>
40 
41 // clang-format off
42 #define TESSERACT_ADD_VISUALIZATION_PLUGIN(DERIVED_CLASS, ALIAS) \
43  TESSERACT_ADD_PLUGIN_SECTIONED(DERIVED_CLASS, ALIAS, Plotter)
44 // clang-format on
45 
47 {
48 class Marker;
49 
52 {
53 public:
54  using Ptr = std::shared_ptr<Visualization>;
55  using ConstPtr = std::shared_ptr<const Visualization>;
56 
57  Visualization() = default;
58  virtual ~Visualization() = default;
59  Visualization(const Visualization&) = default;
60  Visualization& operator=(const Visualization&) = default;
61  Visualization(Visualization&&) = default;
63 
68  virtual bool isConnected() const = 0;
69 
74  virtual void waitForConnection(long seconds = 0) const = 0;
75 
80  virtual void plotEnvironment(const tesseract_environment::Environment& env, std::string ns = "") = 0;
81 
86  virtual void plotEnvironmentState(const tesseract_scene_graph::SceneState& state, std::string ns = "") = 0;
87 
93  virtual void plotTrajectory(const tesseract_common::JointTrajectory& traj,
94  const tesseract_scene_graph::StateSolver& state_solver,
95  std::string ns = "") = 0;
96 
102  virtual void plotMarker(const Marker& marker, std::string ns = "") = 0;
103 
109  virtual void plotMarkers(const std::vector<std::shared_ptr<Marker>>& markers, std::string ns = "") = 0;
110 
115  virtual void clear(std::string ns = "") = 0;
116 
118  virtual void waitForInput(std::string message = "Hit enter key to continue!") = 0;
119 };
120 
121 } // namespace tesseract_visualization
122 
123 #endif // TESSERACT_VISUALIZATION_VISUALIZATION_H
tesseract_visualization::Visualization::plotEnvironment
virtual void plotEnvironment(const tesseract_environment::Environment &env, std::string ns="")=0
Plot environment.
tesseract_visualization::Visualization::isConnected
virtual bool isConnected() const =0
Some plotters may require connecting to external software.
tesseract_visualization::Visualization::clear
virtual void clear(std::string ns="")=0
This is called at the start of the plotting for each iteration to clear previous iteration graphics i...
tesseract_scene_graph::StateSolver
TESSERACT_COMMON_IGNORE_WARNINGS_PUSH
#define TESSERACT_COMMON_IGNORE_WARNINGS_PUSH
tesseract_visualization::Visualization::operator=
Visualization & operator=(const Visualization &)=default
tesseract_visualization::Visualization::plotEnvironmentState
virtual void plotEnvironmentState(const tesseract_scene_graph::SceneState &state, std::string ns="")=0
Plot state of the environment.
tesseract_visualization::Visualization
The Vizualization class.
Definition: visualization.h:51
tesseract_visualization::Visualization::plotTrajectory
virtual void plotTrajectory(const tesseract_common::JointTrajectory &traj, const tesseract_scene_graph::StateSolver &state_solver, std::string ns="")=0
Plot a JointTrajectory.
tesseract_visualization::Visualization::waitForConnection
virtual void waitForConnection(long seconds=0) const =0
Wait for connection.
tesseract_scene_graph::SceneState
tesseract_visualization::Visualization::Visualization
Visualization()=default
tesseract_common::JointTrajectory
tesseract_visualization::Visualization::waitForInput
virtual void waitForInput(std::string message="Hit enter key to continue!")=0
Pause code and wait for enter key in terminal.
tesseract_visualization::Visualization::Ptr
std::shared_ptr< Visualization > Ptr
Definition: visualization.h:54
tesseract_environment::Environment
TESSERACT_COMMON_IGNORE_WARNINGS_POP
tesseract_visualization::Visualization::ConstPtr
std::shared_ptr< const Visualization > ConstPtr
Definition: visualization.h:55
fwd.h
tesseract_visualization::Marker
Definition: marker.h:74
tesseract_visualization::Visualization::plotMarker
virtual void plotMarker(const Marker &marker, std::string ns="")=0
Plot marker.
tesseract_visualization::Visualization::plotMarkers
virtual void plotMarkers(const std::vector< std::shared_ptr< Marker >> &markers, std::string ns="")=0
Plot a vector of markers under a given namespace.
macros.h
tesseract_visualization::Visualization::~Visualization
virtual ~Visualization()=default
tesseract_visualization
Definition: fwd.h:4


tesseract_visualization
Author(s): Levi Armstrong
autogenerated on Wed Apr 9 2025 03:03:25