Uranium
Application Framework
UM.Scene.Selection.Selection Class Reference

This class is responsible for keeping track of what objects are selected It uses signals to notify others of changes in the selection It also has a convenience function that allows it to apply a single operation to all selected objects. More...

Public Member Functions

def add
 
def remove
 
def getFaceSelectMode (cls)
 
def setFaceSelectMode
 
def setFace
 
def unsetFace
 
def toggleFace
 
def hoverFace
 
def unhoverFace
 
def getCount (cls)
 Get number of selected objects.
 
def getAllSelectedObjects (cls)
 
def getSelectedFace (cls)
 
def getHoverFace (cls)
 
def getBoundingBox (cls)
 
def getSelectedObject
 Get selected object by index. More...
 
def isSelected
 
def clear (cls)
 
def clearFace (cls)
 
def hasSelection (cls)
 Check if anything is selected at all. More...
 
def getSelectionCenter (cls)
 
def applyOperation (cls, operation, args, kwargs)
 Apply an operation to the entire selection. More...
 

Static Public Attributes

tuple selectionChanged = Signal()
 
tuple selectionCenterChanged = Signal()
 
tuple selectedFaceChanged = Signal()
 
tuple hoverFaceChanged = Signal()
 

Detailed Description

This class is responsible for keeping track of what objects are selected It uses signals to notify others of changes in the selection It also has a convenience function that allows it to apply a single operation to all selected objects.

Member Function Documentation

def UM.Scene.Selection.Selection.applyOperation (   cls,
  operation,
  args,
  kwargs 
)

Apply an operation to the entire selection.

This will create and push an operation onto the operation stack. Dependent on whether there is one item selected or multiple it will be just the operation or a grouped operation containing the operation for each selected node.

Parameters
operationClass The operation to create and push. It should take a SceneNode as first positional parameter.
argsThe additional positional arguments passed along to the operation constructor.
kwargsThe additional keyword arguments that will be passed along to the operation constructor.
Returns
list of instantiated operations
def UM.Scene.Selection.Selection.getSelectedObject (   cls,
  index 
)

Get selected object by index.

Parameters
indexindex of the object to return
Returns
selected object or None if index was incorrect / not found
def UM.Scene.Selection.Selection.hasSelection (   cls,
  bool 
)

Check if anything is selected at all.


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