> For the complete documentation index, see [llms.txt](https://sparkar-community.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sparkar-community.gitbook.io/docs/scenemodule.md).

# SceneModule

[`AmbientLightSource`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.ambientlightsource)

The `AmbientLightSource` class describes an ambient lighting source.

[`BlendShape`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.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`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.blendshapesmesh)

The `BlendShapesMesh` class encapsulates multiple blendable meshes.

[`BlockSceneRoot`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.blocksceneroot)

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

[`BoundingBox`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.boundingbox)

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

[`Bounds2D`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.bounds2d)

The `Bounds2D` class describes the bounds of a scene element.

[`Camera`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.camera)

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

[`CameraVisibility`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.cameravisibility)

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

[`Canvas`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.canvas)

The `Canvas` class describes a scene canvas.

[`DirectionalLightSource`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.directionallightsource)

The `DirectionalLightSource` class describes a directional light source.

[`DynamicExtrusion`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.dynamicextrusion)

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

[`FaceAnchor`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.faceanchor)

The `FaceAnchor` class describes an anchored face.

[`FaceMesh`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.facemesh)

The `FaceMesh` class describes a face mesh.

[`FaceTracker`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.facetracker)

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

[`FocalDistance`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.focaldistance)

The `FocalDistance` class describes a focal distance.

[`FocalPlane`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.focalplane)

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

[`HandTrackerSceneObject`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.handtrackersceneobject)

The `HandTrackerSceneObject` class encapsulates a hand tracking object.

[`Joint`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.joint)

The `Joint` class encapsulates a joint scene object.

[`Mesh`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.mesh)

The `Mesh` class describes a scene mesh.

[`OutputVisibility`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.outputvisibility)

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

[`ParticleSystem`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.particlesystem)

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

[`ParticleTypeDescription`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.particletypedescription)

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

[`ParticleTypeDescriptions`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.particletypedescriptions)

The `ParticleTypeDescriptions` class provides a container for particle type descriptions.

[`PlanarDiv`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.planardiv)

The `PlanarDiv` class describes a div on a plane.

[`PlanarFlexContainer`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.planarflexcontainer)

The `PlanarFlexContainer` class describes a flex container on a plane.

[`PlanarFlexItem`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.planarflexitem)

The `PlanarFlexItem` class describes a flex item on a plane.

[`PlanarImage`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.planarimage)

The `PlanarImage` class describes an image rendered on a plane.

[`PlanarObject`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.planarobject)

The `PlanarObject` class describes an object on a plane.

[`PlanarText`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.planartext)

The `PlanarText` class describes text on a plane.

[`Plane`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.plane)

The `Plane` class describes a plane.

[`PlaneTracker`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.planetracker)

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

[`PointLightSource`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.pointlightsource)

The `PointLightSource` class describes a point light source.

[`Scene`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.scene)

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

[`SceneObject`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.sceneobject)

The `SceneObject` class describes an object in a scene.

[`SceneObjectBase`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.sceneobjectbase)

The `SceneObjectBase` class describes a scene object.

[`ScreenPlane`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.screenplane)

The `ScreenPlane` class describes a screen plane.

[`segmentation`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.segmentation)

The `segmentation` class encapsulates image segmentation.

[`Skeleton`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.skeleton)

The `Skeleton` class describes a skeleton object.

[`Speaker`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.speaker)

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

[`SpotLightSource`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.spotlightsource)

The `SpotLightSource` class describes a spot light source.

[`SvgImage`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.svgimage)

The `SvgImage` class describes an SVG asset for a scene.

[`TargetTracker`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.targettracker)

The `TargetTracker` encapsulates a tracker for some target.

[`TextAlignmentWrapper`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.textalignmentwrapper)

The `TextAlignmentWrapper` class contains text alignment details.

[`TextExtrusion`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.textextrusion)

The `TextExtrusion` class describes a 3D text scene object.

[`Transform`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.transform)

The `Transform` class describes an object transform for a scene.

[`WorldTransform`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/scenemodule.worldtransform)

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


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://sparkar-community.gitbook.io/docs/scenemodule.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.