Uranium
Application Framework
UM.Controller.Controller Class Reference

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

Public Member Functions

def __init__
 
def getApplication (self)
 Get the application. More...
 
def addView
 Add a view by name if it"s not already added. More...
 
def getView
 Request view by name. More...
 
def getAllViews (self)
 Return all views. More...
 
def getActiveView (self)
 Request active view. More...
 
def setActiveView
 Set the currently active view. More...
 
def enableModelRendering (self)
 
def disableModelRendering (self)
 
def isModelRenderingEnabled (self)
 
def addStage
 Add a stage by name if it's not already added. More...
 
def getStage
 Request stage by name. More...
 
def getAllStages (self)
 Return all stages. More...
 
def getActiveStage (self)
 Request active stage. More...
 
def setActiveStage
 Set the currently active stage. More...
 
def addInputDevice
 Add an input device (e.g. More...
 
def getInputDevice
 Request input device by name. More...
 
def removeInputDevice
 Remove an input device from the list of input devices. More...
 
def getTool
 Request tool by name. More...
 
def getAllTools (self)
 Get all tools. More...
 
def addTool (self, tool)
 Add a Tool (transform object, translate object) if its not already added. More...
 
def isToolOperationActive (self)
 Gets whether a tool is currently in use. More...
 
def getActiveTool (self)
 Request active tool. More...
 
def setActiveTool (self, tool)
 Set the current active tool. More...
 
def getScene (self)
 Get the scene. More...
 
def event
 Process an event. More...
 
def setCameraTool (self, tool)
 Set the tool used for handling camera controls. More...
 
def getCameraTool (self)
 Get the camera tool (if any) More...
 
def setSelectionTool (self, tool)
 Set the tool used for performing selections. More...
 
def getToolsEnabled (self)
 
def setToolsEnabled (self, enabled)
 
def rotateView (self, coordinate="x", angle=0)
 

Static Public Attributes

 viewsChanged = Signal()
 Emitted when the list of views changes. More...
 
 activeViewChanged = Signal()
 Emitted when the active view changes. More...
 
 stagesChanged = Signal()
 Emitted when the list of stages changes. More...
 
 activeStageChanged = Signal()
 Emitted when the active stage changes. More...
 
 toolsChanged = Signal()
 Emitted when the list of tools changes. More...
 
 toolEnabledChanged = Signal()
 Emitted when a tool changes its enabled state. More...
 
 activeToolChanged = Signal()
 Emitted when the active tool changes. More...
 
 toolOperationStarted = Signal()
 Emitted whenever a tool starts a longer operation. More...
 
 toolOperationStopped = Signal()
 Emitted whenever a tool stops a longer operation. More...
 
 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.

See also
View
Tool
Scene

Member Function Documentation

◆ addInputDevice()

def UM.Controller.Controller.addInputDevice (   self,
  device 
)

Add an input device (e.g.

mouse, keyboard, etc) if it's not already added.

Parameters
deviceThe input device to be added

◆ addStage()

def UM.Controller.Controller.addStage (   self,
  stage 
)

Add a stage by name if it's not already added.

Parameters
namestring Unique identifier of stage (usually the plugin name)
stageStage The stage to be added

◆ addTool()

def UM.Controller.Controller.addTool (   self,
  tool 
)

Add a Tool (transform object, translate object) if its not already added.

Parameters
toolTool Tool to be added

◆ addView()

def UM.Controller.Controller.addView (   self,
  view 
)

Add a view by name if it"s not already added.

Parameters
namestring Unique identifier of view (usually the plugin name)
viewView The view to be added

◆ event()

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

Process an event.

Parameters
eventEvent event to be handle. The event is first passed to the camera tool, then active tool and finally selection tool. If none of these events handle it (when they return something that does not evaluate to true) a context menu signal is emitted.

◆ getActiveStage()

def UM.Controller.Controller.getActiveStage (   self,
  Optional,
  Stage 
)

Request active stage.

Returns None if there is no active stage

Returns
stage Stage if an stage is active, None otherwise.

◆ getActiveTool()

def UM.Controller.Controller.getActiveTool (   self)

Request active tool.

Returns None if there is no active tool

Returns
Tool Tool if an 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

Returns
view View if an view is active, None otherwise.

◆ getAllStages()

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

Return all stages.

Returns
stages dict

◆ getAllTools()

def UM.Controller.Controller.getAllTools (   self)

Get all tools.

Returns
tools dict

◆ getAllViews()

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

Return all views.

Returns
views dict

◆ getApplication()

def UM.Controller.Controller.getApplication (   self)

Get the application.

Returns
Application {Application}

◆ getCameraTool()

def UM.Controller.Controller.getCameraTool (   self)

Get the camera tool (if any)

Returns
camera tool (or none)

◆ getInputDevice()

def UM.Controller.Controller.getInputDevice (   self,
  name 
)

Request input device by name.

Returns None if no device is found.

Parameters
namestring Unique identifier of input device (usually the plugin name)
Returns
input InputDevice device if name was found, none otherwise.

◆ getScene()

def UM.Controller.Controller.getScene (   self,
  Scene 
)

Get the scene.

Returns
scene Scene

◆ getStage()

def UM.Controller.Controller.getStage (   self,
  name 
)

Request stage by name.

Returns None if no stage is found.

Parameters
namestring Unique identifier of stage (usually the plugin name)
Returns
Stage Stage if name was found, none otherwise.

◆ getTool()

def UM.Controller.Controller.getTool (   self,
  name 
)

Request tool by name.

Returns None if no view is found.

Parameters
namestring Unique identifier of tool (usually the plugin name)
Returns
tool Tool if name was found, none otherwise.

◆ getView()

def UM.Controller.Controller.getView (   self,
  name 
)

Request view by name.

Returns None if no view is found.

Parameters
namestring Unique identifier of view (usually the plugin name)
Returns
View View if name was found, none otherwise.

◆ isToolOperationActive()

def UM.Controller.Controller.isToolOperationActive (   self,
  bool 
)

Gets whether a tool is currently in use.

Returns
bool true if a tool current being used.

◆ removeInputDevice()

def UM.Controller.Controller.removeInputDevice (   self,
  name 
)

Remove an input device from the list of input devices.

Does nothing if the input device is not in the list.

Parameters
namestring The name of the device to remove.

◆ setActiveStage()

def UM.Controller.Controller.setActiveStage (   self,
  name 
)

Set the currently active stage.

Parameters
namestring The name of the stage to set as active

◆ setActiveTool()

def UM.Controller.Controller.setActiveTool (   self,
  tool 
)

Set the current active tool.

The tool can be set by name of the tool or directly passing the tool object.

Parameters
toolTool or string

◆ setActiveView()

def UM.Controller.Controller.setActiveView (   self,
  name 
)

Set the currently active view.

Parameters
namestring The name of the view to set as active

◆ setCameraTool()

def UM.Controller.Controller.setCameraTool (   self,
  tool 
)

Set the tool used for handling camera controls.

Camera tool is the first tool to receive events. The tool can be set by name of the tool or directly passing the tool object.

Parameters
toolTool or string
See also
setSelectionTool
setActiveTool

◆ setSelectionTool()

def UM.Controller.Controller.setSelectionTool (   self,
  tool 
)

Set the tool used for performing selections.

Selection tool receives its events after camera tool and active tool. The tool can be set by name of the tool or directly passing the tool object.

Parameters
toolTool or string
See also
setCameraTool
setActiveTool

Member Data Documentation

◆ activeStageChanged

UM.Controller.Controller.activeStageChanged = Signal()
static

Emitted when the active stage changes.

◆ activeToolChanged

UM.Controller.Controller.activeToolChanged = Signal()
static

Emitted when the active tool changes.

◆ activeViewChanged

UM.Controller.Controller.activeViewChanged = Signal()
static

Emitted when the active view changes.

◆ stagesChanged

UM.Controller.Controller.stagesChanged = Signal()
static

Emitted when the list of stages changes.

◆ toolEnabledChanged

UM.Controller.Controller.toolEnabledChanged = Signal()
static

Emitted when a tool changes its enabled state.

◆ toolOperationStarted

UM.Controller.Controller.toolOperationStarted = Signal()
static

Emitted whenever a tool starts a longer operation.

Parameters
toolThe tool that started the operation.
See also
Tool::startOperation

◆ toolOperationStopped

UM.Controller.Controller.toolOperationStopped = Signal()
static

Emitted whenever a tool stops a longer operation.

Parameters
toolThe tool that stopped the operation.
See also
Tool::stopOperation

◆ toolsChanged

UM.Controller.Controller.toolsChanged = Signal()
static

Emitted when the list of tools changes.

◆ viewsChanged

UM.Controller.Controller.viewsChanged = Signal()
static

Emitted when the list of views changes.


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