Public Member Functions | List of all members
gazebo::gui::ModelAlign Class Reference

A gui tool for aligning models. More...

#include <gui/Gui.hh>

Inheritance diagram for gazebo::gui::ModelAlign:
Inheritance graph
[legend]

Public Member Functions

void AlignVisuals (std::vector< rendering::VisualPtr > _visuals, const std::string &_axis, const std::string &_config, const std::string &_target, const bool _publish=true, const bool _inverted=false)
 Callback when a specific alignment configuration is set. More...
 
void Clear ()
 Clear the model alignment tool. More...
 
void Init ()
 Initialize the model alignment tool. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from SingletonT< ModelAlign >
static ModelAlign * Instance ()
 Get an instance of the singleton. More...
 
- Protected Member Functions inherited from SingletonT< ModelAlign >
 SingletonT ()
 Constructor. More...
 
virtual ~SingletonT ()
 Destructor. More...
 

Detailed Description

A gui tool for aligning models.

Member Function Documentation

void gazebo::gui::ModelAlign::AlignVisuals ( std::vector< rendering::VisualPtr _visuals,
const std::string &  _axis,
const std::string &  _config,
const std::string &  _target,
const bool  _publish = true,
const bool  _inverted = false 
)

Callback when a specific alignment configuration is set.

Parameters
[in]_visualsVisuals to be aligned.
[in]_axisAxis of alignment: x, y, or z.
[in]_configEither a configuration (min, center, max), or "reset" to restore the original pose.
[in]_publishTrue to publish new alignment pose
[in]_invertedTrue to invert alignment direction.
void gazebo::gui::ModelAlign::Clear ( )

Clear the model alignment tool.

This explicity cleans up the internal state of the singleton and prepares it for exit.

void gazebo::gui::ModelAlign::Init ( )

Initialize the model alignment tool.


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