Uranium
Application Framework
 All Classes Namespaces Files Functions Variables Pages
UM.Scene.Scene.Scene Class Reference

Container object for the scene graph. More...

Public Member Functions

def __init__
 
def acquireLock
 Acquire the global scene lock. More...
 
def releaseLock
 Release the global scene lock. More...
 
def getSceneLock
 Gets the global scene lock. More...
 
def getRoot
 Get the root node of the scene. More...
 
def setRoot
 Change the root node of the scene.
 
def getActiveCamera
 Get the camera that should be used for rendering. More...
 
def getAllCameras
 
def setActiveCamera
 Set the camera that should be used for rendering. More...
 
def findObject
 Find an object by id. More...
 

Static Public Attributes

tuple rootChanged = Signal()
 
tuple sceneChanged = Signal()
 Signal. More...
 

Detailed Description

Container object for the scene graph.

The main purpose of this class is to provide the root SceneNode.

Member Function Documentation

def UM.Scene.Scene.Scene.acquireLock (   self)

Acquire the global scene lock.

This will prevent any read or write actions on the scene from other threads, assuming those threads also properly acquire the lock. Most notably, this prevents the rendering thread from rendering the scene while it is changing. Deprecated, use getSceneLock() instead.

def UM.Scene.Scene.Scene.findObject (   self,
  object_id 
)

Find an object by id.

Parameters
object_idThe id of the object to search for, as returned by the python id() method.
Returns
The object if found, or None if not.
def UM.Scene.Scene.Scene.getActiveCamera (   self)

Get the camera that should be used for rendering.

def UM.Scene.Scene.Scene.getRoot (   self)

Get the root node of the scene.

def UM.Scene.Scene.Scene.getSceneLock (   self)

Gets the global scene lock.

Use this lock to prevent any read or write actions on the scene from other threads, assuming those threads also properly acquire the lock. Most notably, this prevents the rendering thread from rendering the scene while it is changing.

def UM.Scene.Scene.Scene.releaseLock (   self)

Release the global scene lock.

Deprecated, use getSceneLock() instead.

def UM.Scene.Scene.Scene.setActiveCamera (   self,
  name 
)

Set the camera that should be used for rendering.

Parameters
nameThe name of the camera to use.

Member Data Documentation

tuple UM.Scene.Scene.Scene.sceneChanged = Signal()
static

Signal.

Emitted whenever something in the scene changes.

Parameters
objectThe object that triggered the change.

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