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

A tool handle is a object in the scene that gives queues for what the tool it is 'paired' with can do. More...

Inheritance diagram for UM.Scene.ToolHandle.ToolHandle:
UM.Scene.SceneNode.SceneNode

Public Member Functions

def __init__ (self, parent=None)
 
def getLineMesh (self)
 
def setLineMesh (self, mesh)
 
def getSolidMesh (self)
 
def setSolidMesh (self, mesh)
 
def getSelectionMesh (self)
 
def setSelectionMesh (self, mesh)
 
def getMaterial (self)
 
def render (self, renderer)
 
def setActiveAxis (self, axis)
 
def isAxis (self, value)
 
def buildMesh (self)
 
- Public Member Functions inherited from UM.Scene.SceneNode.SceneNode
def __init__ (self, Optional["SceneNode"] parent=None, **kwargs)
 Construct a scene node. More...
 
def __deepcopy__ (self, memo)
 
def setCenterPosition (self, Vector center)
 Set the center position of this node. More...
 
Optional["SceneNode"] getParent (self)
 Get the parent of this node. More...
 
Vector getMirror (self)
 
Vector setMirror (self, vector)
 
Optional[MeshDatagetBoundingBoxMesh (self)
 Get the MeshData of the bounding box. More...
 
def calculateBoundingBoxMesh (self)
 (re)Calculate the bounding box mesh. More...
 
def addDecorator (self, SceneNodeDecorator decorator)
 Add a SceneNodeDecorator to this SceneNode. More...
 
List[SceneNodeDecoratorgetDecorators (self)
 Get all SceneNodeDecorators that decorate this SceneNode. More...
 
Optional[SceneNodeDecoratorgetDecorator (self, dec_type)
 Get SceneNodeDecorators by type. More...
 
def removeDecorators (self)
 Remove all decorators.
 
def removeDecorator (self, SceneNodeDecorator dec_type)
 Remove decorator by type. More...
 
def callDecoration (self, str function, *args, **kwargs)
 Call a decoration of this SceneNode. More...
 
bool hasDecoration (self, str function)
 Does this SceneNode have a certain Decoration (as defined by a Decorator) More...
 
str getName (self)
 
def setName (self, str name)
 
int getDepth (self)
 How many nodes is this node removed from the root? More...
 
def setParent (self, Optional["SceneNode"] scene_node)
 Set the parent of this object. More...
 
bool isVisible (self)
 Get the visibility of this node. More...
 
def setVisible (self, bool visible)
 Set the visibility of this SceneNode. More...
 
Optional[MeshDatagetMeshData (self)
 Get the (original) mesh data from the scene node/object. More...
 
Optional[MeshDatagetMeshDataTransformed (self)
 Get the transformed mesh data from the scene node/object, based on the transformation of scene nodes wrt root. More...
 
numpy.ndarray getMeshDataTransformedVertices (self)
 Get the transformed vertices from this scene node/object, based on the transformation of scene nodes wrt root. More...
 
numpy.ndarray getMeshDataTransformedNormals (self)
 Get the transformed normals from this scene node/object, based on the transformation of scene nodes wrt root. More...
 
def setMeshData (self, Optional[MeshData] mesh_data)
 Set the mesh of this node/object. More...
 
def addChild (self, "SceneNode" scene_node)
 Add a child to this node and set it's parent as this node. More...
 
def removeChild (self, "SceneNode" child)
 remove a single child More...
 
def removeAllChildren (self)
 Removes all children and its children's children. More...
 
List["SceneNode"] getChildren (self)
 Get the list of direct children. More...
 
bool hasChildren (self)
 
List["SceneNode"] getAllChildren (self)
 Get list of all children (including it's children children children etc.) More...
 
Matrix getWorldTransformation (self)
 Computes and returns the transformation from world to local space. More...
 
Matrix getLocalTransformation (self)
 Returns the local transformation with respect to its parent. More...
 
def setTransformation (self, Matrix transformation)
 
Quaternion getOrientation (self)
 Get the local orientation value. More...
 
Quaternion getWorldOrientation (self)
 
def rotate (self, Quaternion rotation, int transform_space=TransformSpace.Local)
 Rotate the scene object (and thus its children) by given amount. More...
 
def setOrientation (self, Quaternion orientation, int transform_space=TransformSpace.Local)
 Set the local orientation of this scene node. More...
 
Vector getScale (self)
 Get the local scaling value. More...
 
Vector getWorldScale (self)
 
def scale (self, Vector scale, int transform_space=TransformSpace.Local)
 Scale the scene object (and thus its children) by given amount. More...
 
def setScale (self, Vector scale, int transform_space=TransformSpace.Local)
 Set the local scale value. More...
 
Vector getPosition (self)
 Get the local position. More...
 
Vector getWorldPosition (self)
 Get the position of this scene node relative to the world. More...
 
def translate (self, Vector translation, int transform_space=TransformSpace.Local)
 Translate the scene object (and thus its children) by given amount. More...
 
def setPosition (self, Vector position, int transform_space=TransformSpace.Local)
 Set the local position value. More...
 
def lookAt (self, Vector target, Vector up=Vector.Unit_Y)
 Rotate this scene node in such a way that it is looking at target. More...
 
def LOG_MATRIX (self, str_matrix_name, matrix)
 Can be overridden by child nodes if they need to perform special rendering. More...
 
bool isEnabled (self)
 Get whether this SceneNode is enabled, that is, it can be modified in any way. More...
 
def setEnabled (self, bool enable)
 Set whether this SceneNode is enabled. More...
 
bool isSelectable (self)
 Get whether this SceneNode can be selected. More...
 
def setSelectable (self, bool select)
 Set whether this SceneNode can be selected. More...
 
Optional[AxisAlignedBoxgetBoundingBox (self)
 Get the bounding box of this node and its children. More...
 
def setCalculateBoundingBox (self, bool calculate)
 Set whether or not to calculate the bounding box for this node. More...
 
Vector getShear (self)
 
str getSetting (self, str key, str default_value="")
 
def setSetting (self, str key, str value)
 
def __str__ (self)
 String output for debugging. More...
 

Static Public Attributes

int NoAxis = 1
 
int XAxis = 2
 
int YAxis = 3
 
int ZAxis = 4
 
int AllAxis = 5
 
 DisabledSelectionColor = Color(0.5, 0.5, 0.5, 1.0)
 
 XAxisSelectionColor = Color(1.0, 0.0, 0.0, 1.0)
 
 YAxisSelectionColor = Color(0.0, 0.0, 1.0, 1.0)
 
 ZAxisSelectionColor = Color(0.0, 1.0, 0.0, 1.0)
 
 AllAxisSelectionColor = Color(1.0, 1.0, 1.0, 1.0)
 
- Static Public Attributes inherited from UM.Scene.SceneNode.SceneNode
 decoratorsChanged = Signal()
 Signal for when a SceneNodeDecorator is added / removed. More...
 
 parentChanged = Signal()
 Emitted whenever the parent changes. More...
 
 meshDataChanged = Signal()
 Emitted whenever the attached mesh data object changes. More...
 
 childrenChanged = Signal()
 Emitted whenever the list of children of this object or any child object changes. More...
 
 transformationChanged = Signal()
 Signal. More...
 
 boundingBoxChanged = Signal()
 

Detailed Description

A tool handle is a object in the scene that gives queues for what the tool it is 'paired' with can do.

ToolHandles are used for translation, rotation & scale handles. They can also be used as actual objects to interact with (in the case of translation, pressing one arrow of the toolhandle locks the translation in that direction)


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