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

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
 
- Public Member Functions inherited from UM.PluginObject.PluginObject
def __init__ (self)
 
def getPluginId (self)
 
def setPluginId (self, plugin_id)
 
def setVersion
 
def 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()

def UM.Tool.Tool.event (   self,
  event 
)

Handle an event.

Parameters
eventEvent The event to handle.
Returns
bool true if this event has been handled and requires no further processing.
See also
Event

◆ getHandle()

def UM.Tool.Tool.getHandle (   self,
  Optional,
  ToolHandle 
)

Get the associated handle.

Returns
ToolHandle

◆ getLockedAxis()

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.

◆ setHandle()

def UM.Tool.Tool.setHandle (   self,
  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: