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

None add (cls, SceneNode object)
 
None remove (cls, SceneNode object)
 
bool getFaceSelectMode (cls)
 
None setFaceSelectMode (cls, bool select)
 
None setFace (cls, SceneNode object, int face_id)
 
None unsetFace (cls, Optional["SceneNode"] object=None)
 
None toggleFace (cls, SceneNode object, int face_id)
 
None hoverFace (cls, SceneNode object, int face_id)
 
None unhoverFace (cls, Optional["SceneNode"] object=None)
 
int getCount (cls)
 Get number of selected objects.
 
List[SceneNodegetAllSelectedObjects (cls)
 
Optional[Tuple[SceneNode, int]] getSelectedFace (cls)
 
Optional[Tuple[SceneNode, int]] getHoverFace (cls)
 
AxisAlignedBox getBoundingBox (cls)
 
Optional[SceneNodegetSelectedObject (cls, int index)
 Get selected object by index. More...
 
bool isSelected (cls, SceneNode object)
 
def clear (cls)
 
def clearFace (cls)
 
bool hasSelection (cls)
 Check if anything is selected at all.
 
Vector getSelectionCenter (cls)
 
def applyOperation (cls, operation, *args, **kwargs)
 Apply an operation to the entire selection. More...
 

Static Public Attributes

 selectionChanged = Signal()
 
 selectionCenterChanged = Signal()
 
 selectedFaceChanged = Signal()
 
 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

◆ applyOperation()

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

◆ getSelectedObject()

Optional[SceneNode] UM.Scene.Selection.Selection.getSelectedObject (   cls,
int  index 
)

Get selected object by index.

Parameters
indexindex of the object to return
Returns
selected object or None if index was incorrect / not found

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