Scene

The Scene class implements properties and methods to access the objects in a scene.

Properties

PropertyDescription
hidden
(get) hidden: BoolSignal
(set) hidden: void
Specifies whether the scene and its descendants are hidden.

Methods

MethodDescription
child
child(name: string): SceneObjectBase
Returns a child object by name. An exception is thrown if the object isn't found. **See Also**: SceneObjectBase.find, SceneModule.root
find
find(name: string): SceneObjectBase
Returns a descendant object by name. An exception is thrown if the object isn't found or if more than one is found. **Note**: object D is considered to be a descendant of object P if either D is a child of P or if such an object C which is a child of P exists that D is a descendant of C. **See Also**: SceneObjectBase.child, SceneModule.root.
findAll
findAll(name: string, config?: {recursive: boolean}): Promise<Array<SceneObjectBase>>
Returns a promise that is resolved with the all of the scene objects with given name or empty array if none was found. recursive param of config controls whenever the find should be performed recursively (true by default). Empty array is returned in no objects are found. **See Also**: SceneObjectBase.findFirst, SceneObjectBase.findByPath, SceneModule.root.
findByPath
findByPath(pathQuery: string, config?: {limit: number}): Promise<Array<SceneObjectBase>>
Returns a promise that is resolved with the all occurances of scene objects matching the path query or empty array if none was found. Path query format: * matches any characters sequence. * as standalone component matches one level of the scene tree (i.e. any child) ** as standalone component matches any level of scene tree (will result in recursive find) / is a path component separator \ can be used to include in component name any of the control characters (including '\' itself) Examples: findByPath("*") will match all the direct children of the caller. findByPath("* /A") will match all grandchildren of the caller named A. findByPath("** /A") will match all descendants of the caller named A. findByPath("A*") will match all children of the caller which name is prefixed with 'A', like 'ABC'. findByPath("** /*A*") will match all descendants of the caller which name contains 'A', like 'AX' and 'XA'. findByPath("** /A", {limit: 10}) will match at most first 10 descendants of the caller named A. findByPath("\\*") will match all children of the caller named *. findByPath("\\\\") will match all children of the caller named \. limit parameter describes if findByPath should finish the search if it finds specified number of results (default is no limit). Non-positive values for limit are treated as unlimited. **Note**: object D is considered to be a descendant of object P if either D is a child of P or if such an object C which is a child of P exists that D is a descendant of C. **See Also**: SceneObjectBase.findAll, SceneObjectBase.findFirst, SceneModule.root.
findFirst
findFirst(name: string, config?: {recursive: boolean}): Promise<SceneObjectBase>
Returns a promise that is resolved with the first occurance of scene object with given name or null if none was found. recursive param of config controls whenever the find should be performed recursively (true by default). **See Also**: SceneObjectBase.findAll, SceneObjectBase.findByPath, SceneModule.root.