Abstract base class for tools that manipulate (or otherwise interact with) the scene.
More...
|
def | __init__ (self) |
|
def | getExposedProperties (self) |
|
def | setExposedProperties |
|
def | getShortcutKey (self) |
|
def | event |
| Handle an event. More...
|
|
def | getController (self) |
| Convenience function.
|
|
def | getEnabled (self) |
| Get the enabled state of the tool.
|
|
def | getHandle (self) |
| Get the associated handle. More...
|
|
def | setHandle |
| set the associated handle More...
|
|
def | getLockedAxis (self) |
| Get which axis is locked, if any. More...
|
|
def | setLockedAxis |
|
def | getDragPlane (self) |
|
def | setDragPlane |
|
def | getDragStart (self) |
|
def | setDragStart |
|
def | getDragPosition |
|
def | getDragVector |
|
def | __init__ (self, args, kwags) |
|
def | getId (self) |
|
def | setPluginId |
|
def | setMetaData |
|
def | getMetaData (self) |
|
def | getPluginId (self) |
|
def | setVersion |
|
def | getVersion (self) |
|
Abstract base class for tools that manipulate (or otherwise interact with) the scene.
def UM.Tool.Tool.event |
( |
|
self, |
|
|
|
event |
|
) |
| |
Handle an event.
- Parameters
-
event | The event to handle. |
- Returns
- True if this event has been handled and requires no further processing.
- See also
- Event
def UM.Tool.Tool.getHandle |
( |
|
self, |
|
|
|
Optional, |
|
|
|
ToolHandle |
|
) |
| |
Get the associated handle.
- Returns
- ToolHandle
def UM.Tool.Tool.getLockedAxis |
( |
|
self, |
|
|
|
int |
|
) |
| |
Get which axis is locked, if any.
- Returns
- The ID of the axis or axes that are locked. See the
ToolHandle
class for the associations of IDs to each axis.
def UM.Tool.Tool.setHandle |
( |
|
self, |
|
|
|
handle |
|
) |
| |
set the associated handle
- Parameters
-
tuple UM.Tool.Tool.operationStarted = Signal() |
|
static |
Should be emitted whenever a longer running operation is started, like a drag to scale an object.
- Parameters
-
tool | The tool that started the operation. |
tuple UM.Tool.Tool.operationStopped = Signal() |
|
static |
Should be emitted whenever a longer running operation is stopped.
- Parameters
-
tool | The tool that stopped the operation. |
The documentation for this class was generated from the following file: