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 | 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... | |
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 |
void | MakeSolid (const rendering::NodePtr &_node) |
Reset the node to its solid form, intended to be called after MakeTransparent. More... | |
void | MakeTransparent (const rendering::NodePtr &_node) |
Makes the node transparent. More... | |
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... | |
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()
|
override |
Destructor.
Member Function Documentation
◆ AddState()
void AddState | ( | const AlignState & | _state | ) |
Callback to add a state to the execution queue.
- Parameters
-
[in] _state New 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()
|
overrideprotected |
◆ LoadConfig()
|
override |
◆ MakeSolid()
void MakeSolid | ( | const rendering::NodePtr & | _node | ) |
Reset the node to its solid form, intended to be called after MakeTransparent.
- Parameters
-
[in] _node The node to make solid
◆ MakeTransparent()
void MakeTransparent | ( | const rendering::NodePtr & | _node | ) |
Makes the node transparent.
- Parameters
-
[in] _node The node to make transparent
◆ OnAlign
|
slot |
Callback to the align state the execution queue.
◆ OnAlignAxis
|
slot |
Callback to update the axis type.
- Parameters
-
[in] _mode New axis type
◆ OnAlignTarget
|
slot |
Callback to update the target type.
- Parameters
-
[in] _target New target type
◆ OnHoveredEntered
|
slot |
Callback to make whenever a hover state is entered on a button.
◆ OnHoveredExited
|
slot |
Callback to make whenever a hover state is exited on a button.
◆ 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] _scene The scene to check [in] _node The 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] _scene The scene to check [in] _visual The visual to get the top level visual for
◆ Update()
|
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] _info Current simulation information, such as time. [in] _ecm Mutable reference to the ECM, so the system can read and write entities and their components.
Reimplemented from GuiSystem.
The documentation for this class was generated from the following file: