Uranium
Application Framework
UM.Tool.Tool Class Reference

Abstract base class for tools that manipulate (or otherwise interact with) the scene. More...

Inheritance diagram for UM.Tool.Tool:
UM.PluginObject.PluginObject

Public Member Functions

None __init__ (self)
 
List[str] getExposedProperties (self)
 
def setExposedProperties (self, *str args)
 
def getShortcutKey (self)
 
bool event (self, Event event)
 Handle an event. More...
 
Controller getController (self)
 Convenience function.
 
bool getEnabled (self)
 Get the enabled state of the tool.
 
Optional[ToolHandlegetHandle (self)
 Get the associated handle. More...
 
def setHandle (self, ToolHandle handle)
 set the associated handle More...
 
int getLockedAxis (self)
 Get which axis is locked, if any. More...
 
None setLockedAxis (self, int axis)
 
Optional[PlanegetDragPlane (self)
 
None setDragPlane (self, Optional[Plane] plane)
 
Optional[VectorgetDragStart (self)
 
None setDragStart (self, float x, float y)
 
Optional[VectorgetDragPosition (self, float x, float y)
 
Optional[VectorgetDragVector (self, float x, float y)
 
- Public Member Functions inherited from UM.PluginObject.PluginObject
def getPluginId (self)
 
def setPluginId (self, plugin_id)
 
def setVersion (self, str version)
 
str getVersion (self)
 

Static Public Attributes

 operationStarted = Signal()
 Should be emitted whenever a longer running operation is started, like a drag to scale an object. More...
 
 operationStopped = Signal()
 Should be emitted whenever a longer running operation is stopped. More...
 
 propertyChanged = Signal()
 

Detailed Description

Abstract base class for tools that manipulate (or otherwise interact with) the scene.

Member Function Documentation

◆ event()

bool UM.Tool.Tool.event (   self,
Event  event 
)

Handle an event.

Parameters
eventThe event to handle.
Returns
True if this event has been handled and requires no further processing.
See also
Event

◆ getHandle()

Optional[ToolHandle] UM.Tool.Tool.getHandle (   self)

Get the associated handle.

Returns
ToolHandle

◆ getLockedAxis()

int UM.Tool.Tool.getLockedAxis (   self)

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.

◆ setHandle()

def UM.Tool.Tool.setHandle (   self,
ToolHandle  handle 
)

set the associated handle

Parameters
<em>ToolHandle</em>

Member Data Documentation

◆ operationStarted

UM.Tool.Tool.operationStarted = Signal()
static

Should be emitted whenever a longer running operation is started, like a drag to scale an object.

Parameters
toolThe tool that started the operation.

◆ operationStopped

UM.Tool.Tool.operationStopped = Signal()
static

Should be emitted whenever a longer running operation is stopped.

Parameters
toolThe tool that stopped the operation.

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