Gazebo Gazebo

API Reference

6.16.0

Provides buttons for the align tool. More...

#include <AlignTool.hh>

Public Slots

void OnAlign ()
 Callback to the align state the execution queue. More...
 
void OnAlignAxis (const QString &_mode)
 Callback to update the axis type. More...
 
void OnAlignConfig (const QString &_mode)
 Callback to update the axis config. More...
 
void OnAlignTarget (const QString &_target)
 Callback to update the target type. More...
 
void OnHoveredEntered ()
 Callback to make whenever a hover state is entered on a button. More...
 
void OnHoveredExited ()
 Callback to make whenever a hover state is exited on a button. More...
 
void OnReverse (bool _reverse)
 Callback to update if the align orientation is reversed. More...
 

Public Member Functions

 AlignTool ()
 Constructor. More...
 
 ~AlignTool () override
 Destructor. More...
 
void AddState (const AlignState &_state)
 Callback to add a state to the execution queue. More...
 
void Align ()
 The function call to execute a state from the queue. This function makes rendering calls and should only be executed within the render thread. More...
 
void LoadConfig (const tinyxml2::XMLElement *_pluginElem) override
 
rendering::NodePtr TopLevelNode (rendering::ScenePtr &_scene, rendering::NodePtr &_node) const
 Returns the top level node of the passed in node within a given scene. More...
 
rendering::VisualPtr TopLevelVisual (rendering::ScenePtr &_scene, rendering::VisualPtr &_visual) const
 Returns the top level visual of the passed in visual within a given scene. More...
 
void Update (const UpdateInfo &_info, EntityComponentManager &_ecm) override
 Update callback called every time the system is stepped. This is called at an Ignition transport thread, so any interaction with Qt should be done through signals and slots. More...
 
void UpdateTransparency (const rendering::NodePtr &_node, bool _makeTransparent)
 Updates the node to increase its transparency or reset back to its original transparency value, an opaque call requires a previous transparent call, otherwise, no action will be taken. More...
 

Protected Member Functions

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

Detailed Description

Provides buttons for the align tool.

Configuration

<service> : Set the service to receive align tool requests.

Constructor & Destructor Documentation

◆ AlignTool()

AlignTool ( )

Constructor.

◆ ~AlignTool()

~AlignTool ( )
override

Destructor.

Member Function Documentation

◆ AddState()

void AddState ( const AlignState _state)

Callback to add a state to the execution queue.

Parameters
[in]_stateNew state to add by enum AlignState

◆ Align()

void Align ( )

The function call to execute a state from the queue. This function makes rendering calls and should only be executed within the render thread.

◆ eventFilter()

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

◆ LoadConfig()

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

◆ OnAlign

void OnAlign ( )
slot

Callback to the align state the execution queue.

◆ OnAlignAxis

void OnAlignAxis ( const QString &  _mode)
slot

Callback to update the axis type.

Parameters
[in]_modeNew axis type

◆ OnAlignConfig

void OnAlignConfig ( const QString &  _mode)
slot

Callback to update the axis config.

Parameters
[in]_modeNew config type

◆ OnAlignTarget

void OnAlignTarget ( const QString &  _target)
slot

Callback to update the target type.

Parameters
[in]_targetNew target type

◆ OnHoveredEntered

void OnHoveredEntered ( )
slot

Callback to make whenever a hover state is entered on a button.

◆ OnHoveredExited

void OnHoveredExited ( )
slot

Callback to make whenever a hover state is exited on a button.

◆ OnReverse

void OnReverse ( bool  _reverse)
slot

Callback to update if the align orientation is reversed.

Parameters
[in]_reverseThe reverse boolean

◆ TopLevelNode()

rendering::NodePtr TopLevelNode ( rendering::ScenePtr &  _scene,
rendering::NodePtr &  _node 
) const

Returns the top level node of the passed in node within a given scene.

Parameters
[in]_sceneThe scene to check
[in]_nodeThe node to get the top level node for

◆ TopLevelVisual()

rendering::VisualPtr TopLevelVisual ( rendering::ScenePtr &  _scene,
rendering::VisualPtr &  _visual 
) const

Returns the top level visual of the passed in visual within a given scene.

Parameters
[in]_sceneThe scene to check
[in]_visualThe visual to get the top level visual for

◆ Update()

void Update ( const UpdateInfo _info,
EntityComponentManager _ecm 
)
overridevirtual

Update callback called every time the system is stepped. This is called at an Ignition transport thread, so any interaction with Qt should be done through signals and slots.

Parameters
[in]_infoCurrent simulation information, such as time.
[in]_ecmMutable reference to the ECM, so the system can read and write entities and their components.

Reimplemented from GuiSystem.

◆ UpdateTransparency()

void UpdateTransparency ( const rendering::NodePtr &  _node,
bool  _makeTransparent 
)

Updates the node to increase its transparency or reset back to its original transparency value, an opaque call requires a previous transparent call, otherwise, no action will be taken.

Parameters
[in]_nodeThe node to update.
[in]_makeTransparenttrue if updating to increase transparency, false to set back to original transparency values (make more opaque)

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