##

ModelAlign Class Reference

A gui tool for aligning models. More...

`#include <gui/Gui.hh>`

Inherits SingletonT< ModelAlign >.

## 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...

## Static Public Member Functions

static ModelAlign * | Instance ()
| Get an instance of the singleton. More...

## Detailed Description

A gui tool for aligning models.

## Member Function Documentation

## AlignVisuals()

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.

Parameters

  [in] | _visuals | Visuals to be aligned.
  [in] | _axis | Axis of alignment: x, y, or z.
  [in] | _config | Either a configuration (min, center, max), or "reset" to restore the original pose.
  [in] | _publish | True to publish new alignment pose
  [in] | _inverted | True to invert alignment direction.

## Clear()

void Clear | ( |  | ) |

Clear the model alignment tool.

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

## Init()

void Init | ( |  | ) |

Initialize the model alignment tool.

## Instance()

static ModelAlign * Instance | ( |  | ) |

inline static inherited

Get an instance of the singleton.

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

- ModelAlign.hh