Uranium
Application Framework
 All Classes Namespaces Files Functions Variables Pages
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__
 
def getExposedProperties
 
def setExposedProperties
 
def getShortcutKey
 
def event
 Handle an event. More...
 
def getController
 Convenience function.
 
def getEnabled
 Get the enabled state of the tool.
 
def getHandle
 Get the associated handle. More...
 
def setHandle
 set the associated handle More...
 
def getLockedAxis
 Get which axis is locked, if any. More...
 
def setLockedAxis
 
def getDragPlane
 
def setDragPlane
 
def getDragStart
 
def setDragStart
 
def getDragPosition
 
def getDragVector
 
- Public Member Functions inherited from UM.PluginObject.PluginObject
def __init__
 
def getPluginId
 
def setPluginId
 
def setVersion
 
def getVersion
 

Static Public Attributes

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

Detailed Description

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

Member Function Documentation

def UM.Tool.Tool.event (   self,
  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
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
<em>ToolHandle</em>

Member Data Documentation

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
toolThe tool that started the operation.
tuple 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: