SparkAR Community Scripting Docs
  • Spark AR Scripting Reference
  • Audio Analyzer / Energy Meter
  • Asynchronous API Changes (v85+)
  • Custom Instructions
  • AnimationModule
    • ValueDriver
    • TimeDriver
    • SignalRecorder
    • SignalRecord
    • ScalarSampler
    • SamplerFactory
    • RotationSampler
    • Driver
    • ColorSampler
    • ArrayOfScalarSignals
    • ArrayOfScalarSamplers
  • AudioModule
    • PlaybackController
  • CameraInfoModule
    • CameraPosition
  • DeepLinkModule
  • DeviceMotionModule
  • DiagnosticsModule
  • FaceGesturesModule
  • FaceTracking2DModule
    • Face2D
  • FaceTrackingModule
    • Cheek
    • Chin
    • Eye
    • Eyebrow
    • Face
    • Forehead
    • Mouth
    • Nose
  • FontsModule
    • FontId
  • HandTrackingModule
    • Hand
  • InstructionModule
  • IrisTrackingModule
    • Eyeball
  • LightingEstimationModule
  • LiveStreamingModule
    • LiveStreamingModule.State
    • LiveStreamingReactions
    • LiveStreamingComments
  • LocaleModule
  • MaterialsModule
    • TextureTransform
    • RetouchingMaterial
    • MetallicRoughnessPbrMaterial
    • MaterialBase
    • DefaultMaterial
    • ColorPaintMaterial
    • BlendShapeToWarpMapMaterial
    • BlendedMaterial
  • NativeUIModule
    • Picker
  • NetworkingModule
  • PatchesModule
  • PersistenceModule
    • StorageScope
  • PersonSegmentationModule
  • RandomModule
  • ReactiveModule
    • AntiderivativeOverflowBehaviour
    • BoundingBoxSignal
    • ISignal
    • PixelPointSignal
    • PixelSizeSignal
    • Point2D
    • Point2DSignal
    • Point3D
    • Point4DSignal
    • PointSignal
    • PrimitiveOrShaderSignal
    • RgbaSignal
    • BoolSignal
    • Rotation
    • RotationSignal
    • ScalarSignal
    • ScalarValue
    • ScaleSignal
    • ShaderSignal
    • StringSignal
    • StringValue
    • Subscription
    • BoolValue
    • VectorSignal
    • TransformSignal
    • ColorSignal
    • EulerAnglesSignal
    • EventSource
    • HsvaSignal
    • InsetsSignal
  • SceneModule
    • AmbientLightSource
    • BrushType
    • HorizontalAlignment
    • RenderMode
    • ScalingOption
    • TextAlignment
    • TrackingMode
    • SpotLightSource
    • PointLightSource
    • DirectionalLightSource
    • HandTrackerSceneObject
    • Canvas
    • DynamicExtrusion
    • FaceAnchor
    • FaceMesh
    • VerticalTextAlignment
    • VerticalAlignment
    • FaceTracker
    • FocalPlane
    • FocalDistance
    • OutputVisibility
    • Mesh
    • Joint
    • PlaneTracker
    • Plane
    • PlanarText
    • PlanarObject
    • PlanarImage
    • PlanarFlexItem
    • PlanarDiv
    • ParticleTypeDescriptions
    • ParticleSystem
    • ParticleTypeDescription
    • PlanarFlexContainer
    • TextExtrusion
    • SvgImage
    • BlendShapesMesh
    • BlockSceneRoot
    • BoundingBox
    • Bounds2D
    • Camera
    • CameraVisibility
    • BlendShape
    • Scene
    • SceneObjectBase
    • ScreenPlane
    • Skeleton
    • segmentation
    • Speaker
    • Transform
    • TargetTracker
    • TextAlignmentWrapper
    • WorldTransform
    • SceneObject
  • ShadersModule
    • VertexAttribute
    • SdfVariant
    • PhysicallyBasedMaterialTextures
    • GradientType
    • FacePaintMaterialTextures
    • DerivativeType
    • DefaultMaterialTextures
    • ColorSpace
    • BuiltinUniform
    • BlendMode
    • BlendedMaterialTextures
  • SvgsModule
  • TexturesModule
    • State
    • SourceImageRegionTexture
    • SubTexture
    • TextureBase
    • CameraTexture
    • CanvasTexture
    • ColorTexture
    • DeepLinkTexture
    • ExternalTexture
    • ImageTexture
    • SegmentationTexture
    • SequenceTexture
  • TimeModule
  • TouchGesturesModule
    • Type
    • TouchGestureModule.Gesture.State
    • Gesture
    • LongPressGesture
    • PanGesture
    • PinchGesture
    • RawTouchGesture
    • RotateGesture
    • TapGesture
  • UnitsModule
Powered by GitBook
On this page

Was this helpful?

SceneModule

PreviousInsetsSignalNextAmbientLightSource

Last updated 5 years ago

Was this helpful?

The AmbientLightSource class describes an ambient lighting source.

The BlendShape class describes a shape attached to a mesh or face mesh which can be used to change the shape of that mesh.

The BlendShapesMesh class encapsulates multiple blendable meshes.

The BlockSceneRoot class describes the root scene object of a block.

The BoundingBox class describes the bounds of a scene element in the local coordinate system.

The Bounds2D class describes the bounds of a scene element.

The Camera class exposes details about the device camera focal area.

The CameraVisibility class describes whether or not an object is visible from various camera views.

The Canvas class describes a scene canvas.

The DirectionalLightSource class describes a directional light source.

The DynamicExtrusion class provides functionality for creating extruded 3D objects using a brush.

The FaceAnchor class describes an anchored face.

The FaceMesh class describes a face mesh.

The FaceTracker class propagates details of detected faces to the scene.

The FocalDistance class describes a focal distance.

The FocalPlane class exposes details about the focal plane of the device camera.

The HandTrackerSceneObject class encapsulates a hand tracking object.

The Joint class encapsulates a joint scene object.

The Mesh class describes a scene mesh.

The OutputVisibility class describes whether or not an object is visible from various outputs.

The ParticleSystem class implements the particle management system for the scene.

The ParticleTypeDescription class provides functionality for setting particle sprite densities in the scene.

The ParticleTypeDescriptions class provides a container for particle type descriptions.

The PlanarDiv class describes a div on a plane.

The PlanarFlexContainer class describes a flex container on a plane.

The PlanarFlexItem class describes a flex item on a plane.

The PlanarImage class describes an image rendered on a plane.

The PlanarObject class describes an object on a plane.

The PlanarText class describes text on a plane.

The Plane class describes a plane.

The PlaneTracker class provides functionality for locating a 3D plane based on 2D screen coordinates.

The PointLightSource class describes a point light source.

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

The SceneObject class describes an object in a scene.

The SceneObjectBase class describes a scene object.

The ScreenPlane class describes a screen plane.

The segmentation class encapsulates image segmentation.

The Skeleton class describes a skeleton object.

The Speaker class encapsulates an speaker for a scene. Old class name is AudioSource.

The SpotLightSource class describes a spot light source.

The SvgImage class describes an SVG asset for a scene.

The TargetTracker encapsulates a tracker for some target.

The TextAlignmentWrapper class contains text alignment details.

The TextExtrusion class describes a 3D text scene object.

The Transform class describes an object transform for a scene.

The WorldTransform class describes an object tranform for a sceneObject in world space.

AmbientLightSource
BlendShape
BlendShapesMesh
BlockSceneRoot
BoundingBox
Bounds2D
Camera
CameraVisibility
Canvas
DirectionalLightSource
DynamicExtrusion
FaceAnchor
FaceMesh
FaceTracker
FocalDistance
FocalPlane
HandTrackerSceneObject
Joint
Mesh
OutputVisibility
ParticleSystem
ParticleTypeDescription
ParticleTypeDescriptions
PlanarDiv
PlanarFlexContainer
PlanarFlexItem
PlanarImage
PlanarObject
PlanarText
Plane
PlaneTracker
PointLightSource
Scene
SceneObject
SceneObjectBase
ScreenPlane
segmentation
Skeleton
Speaker
SpotLightSource
SvgImage
TargetTracker
TextAlignmentWrapper
TextExtrusion
Transform
WorldTransform