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

Container object for the scene graph. More...

Public Member Functions

def __init__ (self)
 
def setIgnoreSceneChanges
 
def acquireLock (self)
 Acquire the global scene lock. More...
 
def releaseLock (self)
 Release the global scene lock. More...
 
def getSceneLock (self)
 Gets the global scene lock. More...
 
def getRoot (self)
 Get the root node of the scene. More...
 
def setRoot
 Change the root node of the scene.
 
def getActiveCamera (self)
 Get the camera that should be used for rendering. More...
 
def getAllCameras (self)
 
def setActiveCamera
 Set the camera that should be used for rendering. More...
 
def findObject
 Find an object by id. More...
 
def findCamera
 
def addWatchedFile
 Add a file to be watched for changes. More...
 
def removeWatchedFile
 Remove a file so that it will no longer be watched for changes. More...
 

Static Public Attributes

 rootChanged = Signal()
 
 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

◆ acquireLock()

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

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.

◆ addWatchedFile()

def UM.Scene.Scene.Scene.addWatchedFile (   self,
  file_path 
)

Add a file to be watched for changes.

Parameters
file_pathThe path to the file that must be watched.

◆ findObject()

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.

◆ getActiveCamera()

def UM.Scene.Scene.Scene.getActiveCamera (   self,
  Optional,
  Camera 
)

Get the camera that should be used for rendering.

◆ getRoot()

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

Get the root node of the scene.

◆ getSceneLock()

def UM.Scene.Scene.Scene.getSceneLock (   self,
  threading,
  Lock 
)

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.

◆ releaseLock()

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

Release the global scene lock.

Deprecated, use getSceneLock() instead.

◆ removeWatchedFile()

def UM.Scene.Scene.Scene.removeWatchedFile (   self,
  file_path 
)

Remove a file so that it will no longer be watched for changes.

Parameters
file_pathThe path to the file that must no longer be watched.

◆ setActiveCamera()

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

◆ sceneChanged

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: