Uranium
Application Framework
UM.Controller.Controller Class Reference

Public Member Functions

def __init__
 
def addView
 
def getView
 
def getAllViews (self)
 
def getActiveView (self)
 
def setActiveView
 
def addStage
 
def getStage
 
def getAllStages (self)
 
def getActiveStage (self)
 
def setActiveStage
 
def addInputDevice
 
def getInputDevice
 
def removeInputDevice
 
def getFallbackTool (self)
 
def setFallbackTool
 
def getTool
 
def getAllTools (self)
 
def addTool
 
def isToolOperationActive (self)
 
def getActiveTool (self)
 
def setActiveTool
 
def getScene (self)
 
def event
 
def setCameraTool
 
def getCameraTool (self)
 
def setSelectionTool
 
def getToolsEnabled (self)
 
def setToolsEnabled
 
def deleteAllNodesWithMeshData
 
def setCameraRotation
 
def setCameraPosition
 
def setLookAtPosition
 
def setCameraZoomFactor
 
def setCameraOrigin
 

Static Public Attributes

 viewsChanged = Signal()
 
 activeViewChanged = Signal()
 
 stagesChanged = Signal()
 
 activeStageChanged = Signal()
 
 toolsChanged = Signal()
 
 toolEnabledChanged = Signal()
 
 activeToolChanged = Signal()
 
 toolOperationStarted = Signal()
 
 toolOperationStopped = Signal()
 
 contextMenuRequested = Signal()
 

Detailed Description

Glue class that holds the scene, (active) view(s), (active) tool(s) and possible user inputs.

The different types of views / tools / inputs are defined by plugins.
:sa View
:sa Tool
:sa Scene

Member Function Documentation

◆ getActiveStage()

def UM.Controller.Controller.getActiveStage (   self,
  Optional,
  Stage 
)
Request active stage. Returns None if there is no active stage

:return: stage if an stage is active, None otherwise.

◆ getActiveTool()

def UM.Controller.Controller.getActiveTool (   self,
  Optional,
  Tool 
)
Request active tool. Returns None if there is no active tool

:return: Tool if a tool is active, None otherwise.

◆ getActiveView()

def UM.Controller.Controller.getActiveView (   self,
  Optional,
  View 
)
Request active view. Returns None if there is no active view

:return: view if an view is active, None otherwise.

◆ getAllStages()

def UM.Controller.Controller.getAllStages (   self,
  Dict,
  str,
  Stage 
)
Return all stages.

:return: stages

◆ getAllTools()

def UM.Controller.Controller.getAllTools (   self,
  Dict,
  str,
  Tool 
)
Get all tools

:return: tools

◆ getAllViews()

def UM.Controller.Controller.getAllViews (   self,
  Dict,
  str,
  View 
)
Return all views.

:return: views

◆ getCameraTool()

def UM.Controller.Controller.getCameraTool (   self,
  Optional,
  Tool 
)
Get the camera tool (if any)

:returns: camera tool (or none)

◆ getFallbackTool()

def UM.Controller.Controller.getFallbackTool (   self,
  str 
)
Request the current fallbacl tool.

:return: Id of the fallback tool

◆ getScene()

def UM.Controller.Controller.getScene (   self,
  Scene 
)
Get the scene

:return: scene

◆ isToolOperationActive()

def UM.Controller.Controller.isToolOperationActive (   self,
  bool 
)
Gets whether a tool is currently in use

:return: true if a tool current being used.

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