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

Public Member Functions

None __init__ (self)
 
None setIgnoreSceneChanges (self, bool ignore_scene_changes)
 
threading.Lock getSceneLock (self)
 
"SceneNode" getRoot (self)
 
None setRoot (self, "SceneNode" node)
 
Optional[CameragetActiveCamera (self)
 
List[CameragetAllCameras (self)
 
None setActiveCamera (self, str name)
 
Optional["SceneNode"] findObject (self, int object_id)
 
Optional[CamerafindCamera (self, str name)
 
None addWatchedFile (self, str file_path)
 
None removeWatchedFile (self, str file_path)
 

Static Public Attributes

 rootChanged = Signal()
 
 sceneChanged = Signal()
 

Detailed Description

Container object for the scene graph

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

Member Function Documentation

◆ addWatchedFile()

None UM.Scene.Scene.Scene.addWatchedFile (   self,
str  file_path 
)
Add a file to be watched for changes.

:param file_path: The path to the file that must be watched.

◆ findObject()

Optional["SceneNode"] UM.Scene.Scene.Scene.findObject (   self,
int  object_id 
)
Find an object by id.

:param object_id: The id of the object to search for, as returned by the python id() method.

:return: The object if found, or None if not.

◆ getActiveCamera()

Optional[Camera] UM.Scene.Scene.Scene.getActiveCamera (   self)
Get the camera that should be used for rendering.

◆ getRoot()

"SceneNode" UM.Scene.Scene.Scene.getRoot (   self)
Get the root node of the scene.

◆ removeWatchedFile()

None UM.Scene.Scene.Scene.removeWatchedFile (   self,
str  file_path 
)
Remove a file so that it will no longer be watched for changes.

:param file_path: The path to the file that must no longer be watched.

◆ setActiveCamera()

None UM.Scene.Scene.Scene.setActiveCamera (   self,
str  name 
)
Set the camera that should be used for rendering.

:param name: The name of the camera to use.

◆ setRoot()

None UM.Scene.Scene.Scene.setRoot (   self,
"SceneNode"  node 
)
Change the root node of the scene

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