Gazebo Gazebo

API Reference

3.15.1

Provides buttons for translation, rotation, and scale. More...

#include <TransformControl.hh>

Public Slots

void OnMode (const QString &_mode)
 Callback in Qt thread when mode changes. More...
 
void OnSnapToGrid ()
 Callback in Qt thread when the snap to grid button is clicked. More...
 
void OnSnapUpdate (double _x, double _y, double _z, double _roll, double _pitch, double _yaw, double _scaleX, double _scaleY, double _scaleZ)
 Sends an event to update the internal snapping values for translation, rotation, and scaling. More...
 
double pitchSnap ()
 Callback in Qt thread when the snap to grid button is clicked in order to update custom snap values menu. More...
 
double rollSnap ()
 Callback in Qt thread when the snap to grid button is clicked in order to update custom snap values menu. More...
 
double scaleXSnap ()
 Callback in Qt thread when the snap to grid button is clicked in order to update custom snap values menu. More...
 
double scaleYSnap ()
 Callback in Qt thread when the snap to grid button is clicked in order to update custom snap values menu. More...
 
double scaleZSnap ()
 Callback in Qt thread when the snap to grid button is clicked in order to update custom snap values menu. More...
 
double xSnap ()
 Callback in Qt thread when the snap to grid button is clicked in order to update custom snap values menu. More...
 
double yawSnap ()
 Callback in Qt thread when the snap to grid button is clicked in order to update custom snap values menu. More...
 
double ySnap ()
 Callback in Qt thread when the snap to grid button is clicked in order to update custom snap values menu. More...
 
double zSnap ()
 Callback in Qt thread when the snap to grid button is clicked in order to update custom snap values menu. More...
 

Signals

void activateRotate ()
 Notify that rotation has been activated. More...
 
void activateSelect ()
 Notify that selection has been activated. More...
 
void activateTranslate ()
 Notify that translation has been activated. More...
 
void newSnapValues ()
 Notify that new snapping values have been set. More...
 

Public Member Functions

 TransformControl ()
 Constructor. More...
 
 ~TransformControl () override
 Destructor. More...
 
void LoadConfig (const tinyxml2::XMLElement *_pluginElem) override
 
void LoadGrid ()
 Callback to retrieve existing grid. Should only be called within the render thread. If no grid is found, the grid pointer is not updated. More...
 
void SnapToGrid ()
 Sets the custom snap values to the grid values. More...
 

Protected Member Functions

bool eventFilter (QObject *_obj, QEvent *_event) override
 

Detailed Description

Provides buttons for translation, rotation, and scale.

Configuration

<service> : Set the service to receive transform mode requests.

Constructor & Destructor Documentation

◆ TransformControl()

Constructor.

◆ ~TransformControl()

~TransformControl ( )
override

Destructor.

Member Function Documentation

◆ activateRotate

void activateRotate ( )
signal

Notify that rotation has been activated.

◆ activateSelect

void activateSelect ( )
signal

Notify that selection has been activated.

◆ activateTranslate

void activateTranslate ( )
signal

Notify that translation has been activated.

◆ eventFilter()

bool eventFilter ( QObject *  _obj,
QEvent *  _event 
)
overrideprotected

◆ LoadConfig()

void LoadConfig ( const tinyxml2::XMLElement *  _pluginElem)
override

◆ LoadGrid()

void LoadGrid ( )

Callback to retrieve existing grid. Should only be called within the render thread. If no grid is found, the grid pointer is not updated.

◆ newSnapValues

void newSnapValues ( )
signal

Notify that new snapping values have been set.

◆ OnMode

void OnMode ( const QString &  _mode)
slot

Callback in Qt thread when mode changes.

Parameters
[in]_modeNew transform mode

◆ OnSnapToGrid

void OnSnapToGrid ( )
slot

Callback in Qt thread when the snap to grid button is clicked.

◆ OnSnapUpdate

void OnSnapUpdate ( double  _x,
double  _y,
double  _z,
double  _roll,
double  _pitch,
double  _yaw,
double  _scaleX,
double  _scaleY,
double  _scaleZ 
)
slot

Sends an event to update the internal snapping values for translation, rotation, and scaling.

Parameters
[in]_xThe snapping distance along the world's x (red) axis expressed in meters.
[in]_yThe snapping distance along the world's y (green) axis expressed in meters.
[in]_zThe snapping distance along the world's z (blue) axis expressed in meters.
[in]_rollThe snapping distance along the entity's roll (red) axis expressed in degrees.
[in]_pitchThe snapping distance along the entity's pitch (green) axis expressed in degrees.
[in]_yawThe snapping distance along the entity's yaw (blue) axis expressed in degrees.
[in]_scaleXThe snapping scale along the entity's x (red) axis
[in]_scaleYThe snapping scale along the entity's y (green) axis
[in]_scaleZThe snapping scale along the entity's z (blue) axis

◆ pitchSnap

double pitchSnap ( )
slot

Callback in Qt thread when the snap to grid button is clicked in order to update custom snap values menu.

Returns
The set pitch rotational snapping value

◆ rollSnap

double rollSnap ( )
slot

Callback in Qt thread when the snap to grid button is clicked in order to update custom snap values menu.

Returns
The set roll rotational snapping value

◆ scaleXSnap

double scaleXSnap ( )
slot

Callback in Qt thread when the snap to grid button is clicked in order to update custom snap values menu.

Returns
The set x scaling snapping value

◆ scaleYSnap

double scaleYSnap ( )
slot

Callback in Qt thread when the snap to grid button is clicked in order to update custom snap values menu.

Returns
The set y scaling snapping value

◆ scaleZSnap

double scaleZSnap ( )
slot

Callback in Qt thread when the snap to grid button is clicked in order to update custom snap values menu.

Returns
The set z scaling snapping value

◆ SnapToGrid()

void SnapToGrid ( )

Sets the custom snap values to the grid values.

◆ xSnap

double xSnap ( )
slot

Callback in Qt thread when the snap to grid button is clicked in order to update custom snap values menu.

Returns
The set x translational snapping value

◆ yawSnap

double yawSnap ( )
slot

Callback in Qt thread when the snap to grid button is clicked in order to update custom snap values menu.

Returns
The set yaw rotational snapping value

◆ ySnap

double ySnap ( )
slot

Callback in Qt thread when the snap to grid button is clicked in order to update custom snap values menu.

Returns
The set y translational snapping value

◆ zSnap

double zSnap ( )
slot

Callback in Qt thread when the snap to grid button is clicked in order to update custom snap values menu.

Returns
The set z translational snapping value

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