Uranium
Application Framework
UM.Tool.Tool Class Reference
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
 
def getController (self)
 
def getEnabled (self)
 
def getHandle (self)
 
def setHandle
 
def getLockedAxis (self)
 
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, args, kwags)
 
def getId (self)
 
def setPluginId
 
def setMetaData
 
def getMetaData (self)
 
def getPluginId (self)
 
def setVersion
 
def getVersion (self)
 

Static Public Attributes

tuple operationStarted = Signal()
 
tuple operationStopped = Signal()
 
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.getController (   self,
  Controller 
)
Convenience function
def UM.Tool.Tool.getEnabled (   self,
  bool 
)
Get the enabled state of the tool
def UM.Tool.Tool.getHandle (   self,
  Optional,
  ToolHandle 
)
Get the associated handle
def UM.Tool.Tool.getLockedAxis (   self,
  int 
)
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.

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