SceneModule

The SceneModule class exposes properties and methods to access the objects in a scene.

Example

//==============================================================================
// The following example demonstrates how to access named elements from a Scene.
//==============================================================================

// Load in the required module
const Scene = require('Scene');

// Store the root of the Scene tree
const root = Scene.root;

// Locate the camera in the Scene using the child method
const camera = root.child('Device').child('Camera');

// Locate the focal distance in the Scene using the find method
const focalDistance = root.find('Focal Distance');

Properties

Property Description

Property	Description
`root`	`(get) root: SceneObjectBase (set) (Not Available)` Returns an object that is the root of the scene tree. Other objects are accessed by walking down the scene tree from the root using the `SceneObjectBase.child` and `SceneObjectBase.find` methods.

root

(get) root: SceneObjectBase (set) (Not Available)

Returns an object that is the root of the scene tree. Other objects are accessed by walking down the scene tree from the root using the SceneObjectBase.child and SceneObjectBase.find methods.

Methods

Method Description

Method	Description
`unprojectToFocalPlane`	`unprojectToFocalPlane(location: PixelPointSignal): PointSignal` Returns a signal with the value that corresponds to the 3d point (in World Space, in current units) of the given screenSpace point from the PixelPointSignal. The z coordinate of the PointSignal will be calculated so that the 3d point will always be on the canvas (which should be on the Focal Plane). This function can be combined with TouchGestures to create a 3d point signal. `var S = require('Scene') TouchGestures.onPan().subscribe(function(gesture) { var signal = S.unprojectToFocalPlane(gesture.location); });`
`unprojectWithDepth`	`unprojectWithDepth(location: PixelPointSignal, depth: number): PointSignal` Returns a signal with the value that corresponds to the 3d point value (in World Space, in current units) of the given screenSpace point from the PixelPointSignal The z coordinate of the PointSignal will always be equal to the given depth value. The depth should be given in current units. This function can be combined with TouchGestures to create a 3d point signal. `var Scene = require('Scene') var TouchGestures = require('TouchGestures') TouchGestures.onPan().subscribe(function(gesture) { var signal = Scene.unprojectWithDepth(gesture.location, 0.5); });`

unprojectToFocalPlane

unprojectToFocalPlane(location: PixelPointSignal): PointSignal

Returns a signal with the value that corresponds to the 3d point (in World Space, in current units) of the given screenSpace point from the PixelPointSignal. The z coordinate of the PointSignal will be calculated so that the 3d point will always be on the canvas (which should be on the Focal Plane).

This function can be combined with TouchGestures to create a 3d point signal. var S = require('Scene') TouchGestures.onPan().subscribe(function(gesture) { var signal = S.unprojectToFocalPlane(gesture.location); });

unprojectWithDepth

unprojectWithDepth(location: PixelPointSignal, depth: number): PointSignal Returns a signal with the value that corresponds to the 3d point value (in World Space, in current units) of the given screenSpace point from the PixelPointSignal The z coordinate of the PointSignal will always be equal to the given depth value. The depth should be given in current units.

This function can be combined with TouchGestures to create a 3d point signal. var Scene = require('Scene') var TouchGestures = require('TouchGestures') TouchGestures.onPan().subscribe(function(gesture) { var signal = Scene.unprojectWithDepth(gesture.location, 0.5); });

Classes

Class	Description
`AmbientLightSource`	The `AmbientLightSource` class describes an ambient lighting source.
`BlendShape`	The `BlendShape` class describes a shape attached to a mesh or face mesh which can be used to change the shape of that mesh.
`BlendShapesMesh`	The `BlendShapesMesh` class encapsulates multiple blendable meshes.
`BlockSceneRoot`	The `BlockSceneRoot` class describes the root scene object of a block.
`BoundingBox`	The `BoundingBox` class describes the bounds of a scene element in the local coordinate system.
`Bounds2D`	The `Bounds2D` class describes the bounds of a scene element.
`Camera`	The `Camera` class exposes details about the device camera focal area.
`CameraVisibility`	The `CameraVisibility` class describes whether or not an object is visible from various camera views.
`Canvas`	The `Canvas` class describes a scene canvas.
`DirectionalLightSource`	The `DirectionalLightSource` class describes a directional light source.
`DynamicExtrusion`	The `DynamicExtrusion` class provides functionality for creating extruded 3D objects using a brush.
`FaceAnchor`	The `FaceAnchor` class describes an anchored face.
`FaceMesh`	The `FaceMesh` class describes a face mesh.
`FaceTracker`	The `FaceTracker` class propagates details of detected faces to the scene.
`FocalDistance`	The `FocalDistance` class describes a focal distance.
`FocalPlane`	The `FocalPlane` class exposes details about the focal plane of the device camera.
`HandTrackerSceneObject`	The `HandTrackerSceneObject` class encapsulates a hand tracking object.
`Joint`	The `Joint` class encapsulates a joint scene object.
`Mesh`	The `Mesh` class describes a scene mesh.
`OutputVisibility`	The `OutputVisibility` class describes whether or not an object is visible from various outputs.
`ParticleSystem`	The `ParticleSystem` class implements the particle management system for the scene.
`ParticleTypeDescription`	The `ParticleTypeDescription` class provides functionality for setting particle sprite densities in the scene.
`ParticleTypeDescriptions`	The `ParticleTypeDescriptions` class provides a container for particle type descriptions.
`PlanarDiv`	The `PlanarDiv` class describes a div on a plane.
`PlanarFlexContainer`	The `PlanarFlexContainer` class describes a flex container on a plane.
`PlanarFlexItem`	The `PlanarFlexItem` class describes a flex item on a plane.
`PlanarImage`	The `PlanarImage` class describes an image rendered on a plane.
`PlanarObject`	The `PlanarObject` class describes an object on a plane.
`PlanarText`	The `PlanarText` class describes text on a plane.
`Plane`	The `Plane` class describes a plane.
`PlaneTracker`	The `PlaneTracker` class provides functionality for locating a 3D plane based on 2D screen coordinates.
`PointLightSource`	The `PointLightSource` class describes a point light source.
`Scene`	The `Scene` class implements properties and methods to access the objects in a scene.
`SceneObject`	The `SceneObject` class describes an object in a scene.
`SceneObjectBase`	The `SceneObjectBase` class describes a scene object.
`ScreenPlane`	The `ScreenPlane` class describes a screen plane.
`segmentation`	The `segmentation` class encapsulates image segmentation.
`Skeleton`	The `Skeleton` class describes a skeleton object.
`Speaker`	The `Speaker` class encapsulates an speaker for a scene. Old class name is `AudioSource`.
`SpotLightSource`	The `SpotLightSource` class describes a spot light source.
`SvgImage`	The `SvgImage` class describes an SVG asset for a scene.
`TargetTracker`	The `TargetTracker` encapsulates a tracker for some target.
`TextAlignmentWrapper`	The `TextAlignmentWrapper` class contains text alignment details.
`TextExtrusion`	The `TextExtrusion` class describes a 3D text scene object.
`Transform`	The `Transform` class describes an object transform for a scene.
`WorldTransform`	The `WorldTransform` class describes an object tranform for a sceneObject in world space.

Enums

Enum	Description
`HorizontalAlignment`	The `HorizontalAlignment` enum describes how an element is aligned horizontally.
`RenderMode`	The RenderMode enum describes how to render a scene object.
`ScalingOption`	The `ScalingOption` enum describes how an element is scaled.
`TextAlignment`	The `TextAlignment` enum describes how a text element is aligned horizontally.
`TrackingMode`	The `TrackingMode` enum describes how a PlaneTracker is tracking an object.
`VerticalAlignment`	The `VerticalAlignment` enum describes how an element is aligned vertically.
`VerticalTextAlignment`	The `VerticalTextAlignment` enum describes how a text element is aligned vertically.

Join the Spark AR Creator's community

Find inspiration, see examples, get support, and share your work with a network of creators.

Join Community

Join the Spark AR Creator's community

Find inspiration, see examples, get support, and share your work with a network of creators.

Join Community

Frequently asked questions

Have a specific question? Maybe it's been answered.

Read FAQs

About Create Ad Careers Platform Policy Privacy Policy Cookies Terms