Gazebo Sim

API Reference

9.0.0
MarkerManager Class Reference

Creates, deletes, and maintains marker visuals. Only the Scene class should instantiate and use this class. More...

#include <MarkerManager.hh>

Public Member Functions

 MarkerManager ()
 Constructor.
 
virtual ~MarkerManager ()
 Destructor.
 
void Clear ()
 Clear the marker manager Clears internal resources stored in the marker manager. Note: this does not actually destroy the objects.
 
bool Init (const gz::rendering::ScenePtr &_scene)
 Initialize the marker manager.
 
rendering::ScenePtr Scene () const
 Get the scene.
 
void SetScene (rendering::ScenePtr _scene)
 Set the scene to manage.
 
void SetSimTime (const std::chrono::steady_clock::duration &_time)
 Set the simulation time.
 
void SetTopic (const std::string &_name)
 Set the marker service topic name.
 
void Update ()
 Update MarkerManager.
 

Detailed Description

Creates, deletes, and maintains marker visuals. Only the Scene class should instantiate and use this class.

Constructor & Destructor Documentation

◆ MarkerManager()

Constructor.

◆ ~MarkerManager()

virtual ~MarkerManager ( )
virtual

Destructor.

Member Function Documentation

◆ Clear()

void Clear ( )

Clear the marker manager Clears internal resources stored in the marker manager. Note: this does not actually destroy the objects.

◆ Init()

bool Init ( const gz::rendering::ScenePtr &  _scene)

Initialize the marker manager.

Parameters
[in]_sceneReference to the scene.
Returns
True on success

◆ Scene()

rendering::ScenePtr Scene ( ) const

Get the scene.

Returns
Pointer to scene

◆ SetScene()

void SetScene ( rendering::ScenePtr  _scene)

Set the scene to manage.

Parameters
[in]_sceneScene pointer.

◆ SetSimTime()

void SetSimTime ( const std::chrono::steady_clock::duration &  _time)

Set the simulation time.

Parameters
[in]_timeThe provided time.

◆ SetTopic()

void SetTopic ( const std::string _name)

Set the marker service topic name.

Parameters
[in]_nameName of service

◆ Update()

void Update ( )

Update MarkerManager.


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