UM.Tool.Tool Class Reference
Inheritance diagram for UM.Tool.Tool:
Public Member Functions | |
| None | __init__ (self) |
| List[str] | getExposedProperties (self) |
| def | setExposedProperties (self, *str args) |
| Optional[int] | getShortcutKey (self) |
| bool | event (self, Event event) |
| Controller | getController (self) |
| bool | getEnabled (self) |
| Optional[ToolHandle] | getHandle (self) |
| def | setHandle (self, ToolHandle handle) |
| int | getLockedAxis (self) |
| None | setLockedAxis (self, int axis) |
| Optional[Plane] | getDragPlane (self) |
| None | setDragPlane (self, Optional[Plane] plane) |
| Optional[Vector] | getDragStart (self) |
| None | setDragStart (self, float x, float y) |
| Optional[Vector] | getDragPosition (self, float x, float y) |
| Optional[Vector] | getDragVector (self, float x, float y) |
 Public Member Functions inherited from UM.PluginObject.PluginObject | |
| None | __init__ (self, *args, **kwags) |
| str | getId (self) |
| None | setPluginId (self, str plugin_id) |
| None | setMetaData (self, Dict[str, Any] metadata) |
| Dict[str, Any] | getMetaData (self) |
| str | getPluginId (self) |
| None | setVersion (self, str version) |
| str | getVersion (self) |
Static Public Attributes | |
| operationStarted = Signal() | |
| operationStopped = Signal() | |
| propertyChanged = Signal() | |
Detailed Description
Abstract base class for tools that manipulate (or otherwise interact with) the scene.
Constructor & Destructor Documentation
◆ __init__()
| None UM.Tool.Tool.__init__ | ( | self | ) |
Reimplemented from UM.PluginObject.PluginObject.
Member Function Documentation
◆ event()
| bool UM.Tool.Tool.event | ( | self, | |
| Event | event | ||
| ) |
Handle an event.
:param event: The event to handle.
:return: True if this event has been handled and requires no further
processing.
◆ getController()
| Controller UM.Tool.Tool.getController | ( | self | ) |
Convenience function
◆ getEnabled()
| bool UM.Tool.Tool.getEnabled | ( | self | ) |
Get the enabled state of the tool
◆ getHandle()
| Optional[ToolHandle] UM.Tool.Tool.getHandle | ( | self | ) |
Get the associated handle
◆ getLockedAxis()
| int UM.Tool.Tool.getLockedAxis | ( | self | ) |
Get which axis is locked, if any.
:return: The ID of the axis or axes that are locked. See the `ToolHandle`
class for the associations of IDs to each axis.
◆ setHandle()
| def UM.Tool.Tool.setHandle | ( | self, | |
| ToolHandle | handle | ||
| ) |
set the associated handle
The documentation for this class was generated from the following file:
- UM/Tool.py
