SceneObjectBase Class

The SceneObjectBase class describes a scene object.

Module:

Scene

Derived Classes:

AmbientLightSource
AudioSource
Camera
Canvas
DirectionalLightSource
FaceMesh
FaceTracker
Mesh

ParticleSystem
PlanarObject
Plane
PlaneTracker
PointLightSource
SceneObject
ScreenPlane
SpotLightSource

Usage

var Scene = require('Scene');

Properties

PropertyDescription

boundingBoxVisible

(get) boundingBoxVisible: BoolSignal (set) (Not Available)

Represents whether or not the bounding box for the object is visible.

cameraVisibility

(get) cameraVisibility: CameraVisibility (set) (Not Available)

Represents the CameraVisibility that contains a set of flags that specify the scene object (and its descendants) visibility depending on the active camera.

hidden

(get) hidden: BoolValue (set) hidden: BoolSignal

Specifies whether the scene object and its descendants are hidden.

name

(get) name: String (set) (Not Available)

Specifies the scene object name. This is the unique identifier of the object within the list of its siblings (immediate child objects of the same parent object).

Note: the object name is specified in AR Studio UI during design time.

Note: the object name must only be unique withing the list of direct siblings. There can be more than object with the same name in the scene as soon as they have different parents.

See Also: SceneObjectBase.child, SceneObjectBase.find, SceneModule.root.

outputVisibility

(get) outputVisibility: OutputVisibility (set) (Not Available)

Represents the OutputVisibility that contains a set of flags that specify the scene object (and its descendants) visibility depending on the output.

transform

(get) transform: Transform (set) transform: TransformSignal

Represents the object transformation, in object's local coordinate system.

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.