Skip to main content

Components

Every component a plugin can add to a scene object and edit.

Commonly used

Guides

All APIs in this topic

Add components to a scene object with sceneObject.addComponent('Camera'). APIs listed by a short name are in Editor.Components: AnimationPlayer is Editor.Components.AnimationPlayer.

Components, assets, and modules

APIDescription
AnimationPlayerComponent that manages animation playback with clips and autoplay settings.
AudioComponentManages audio playback and spatial audio properties for a scene object.
BaseMeshVisualBase class for mesh-based visual components.
CameraRenders the scene from a viewpoint with configurable projection and output.
CanvasManages 2D canvas rendering and layout properties for a scene object.
ClothVisualSimulates cloth physics with stretching, bending, and collision interactions.
ComponentBase class for components attached to scene objects.
CompositionLayerComponentBase class for components attached to scene objects.
CompositionLayerRenderComponentBase class for components attached to scene objects.
DeviceTrackingComponent that configures device tracking behavior and options.
EyeColorVisualVisual component for rendering eye color on a face mesh.
FaceInsetVisualVisual component for rendering an inset region of a face mesh with customizable borders.
FaceMaskVisualVisual component for rendering face masks with optional mouth and teeth correction.
FaceStretchVisualVisual component for stretching and deforming face meshes with named features.
GaussianSplattingVisualRenders a Gaussian Splatting asset with optional frame selection for animated content.
HairVisualRenders and simulates hair with physics, collision, and material properties.
HeadComponent that attaches a scene object to a tracked head position.
ImageRenders a 2D image with optional flip, pivot, and rotation.
InteractionComponentHandles touch and interaction detection on 3D meshes.
LightSourceComponent controlling light properties, shadows, and environment mapping.
LiquifyVisualVisual component applying liquify distortion to face mesh geometry.
LocatedAtComponentPins a scene object to a real-world location asset.
LookAtComponentRotates an object to face a target point or direction.
ManipulateComponentEnables drag, rotate, and scale interactions on a scene object.
MarkerTrackingComponentTracks a marker asset for marker-based AR anchoring.
MaskingComponentApplies a rounded-corner mask to a scene object.
MaterialMeshVisualBase class for mesh visual components that render with materials.
ObjectTrackingTracks 2D objects in the camera feed using ML classification.
ObjectTracking3DTracks and matches 3D objects in the scene using pose estimation.
PinToMeshComponentComponent that pins a SceneObject to a point on a mesh surface.
PostEffectVisualVisual component for rendering post-effect materials.
RectangleSetterComponent for setting rectangular regions on textures.
RenderLayerOwnerThe render layer which the component will be on.
RenderMeshVisualRenders a mesh with customizable blend shapes and normals.
RetouchVisualVisual component for applying retouching effects to faces.
ScreenRegionComponentComponent that defines a rectangular region on screen.
ScreenTransformComponent for positioning and scaling UI elements relative to screen dimensions.
ScriptComponentComponent that runs a script asset.
SkinRepresents a skeletal rigging component that controls deformation of mesh geometry through bone transformations.
TextRenders and manages text in the scene with customizable font, size, layout, and visual effects.
Text3D3D text rendering component with font, layout, and styling options.
VisualBase class for visual components that control rendering order and appearance.

Objects and data

APIDescription
BackgroundSettingsConfigures background styling for UI components.
BarycentricVertexSettings used with Editor.Components.Head to set position on the face.
CameraClearColorThe same entity as in Lens Scripting.
CameraClearDepthThe same entity as in Lens Scripting.
DropshadowSettingsDrop shadow settings for text rendering.
Editor.ComponentsContainer for all scene component types and related enums.
FontStylesStandard font style names for the preferredStyle property of Editor.Components.Text and Editor.Components.Text3D.
OutlineSettingsSettings for outline rendering on a component.
PhysicsNamespace containing physics simulation components, shapes, and constraints for rigid bodies and colliders.
PinToMesh
RotationOptionsConfigures rotation behavior for entities.
ScreenTransformConstraintsUsed with Editor.Components.ScreenTransformConstraints.
StretchPointDefines a mesh vertex stretch point for FaceStretchVisual deformation.
SurfaceOptionsConfiguration for surface rendering options.
TextAdvancedLayoutAdvanced text layout configuration for controlling text appearance and spacing.
TextFillConfigures fill properties for text rendering.

Enums

APIDescription
CameraAspectPresetThe same entity as in Lens Scripting.
CameraDepthBufferModeThe same entity as in Lens Scripting.
CameraDevicePropertyThe same entity as in Lens Scripting.
CameraOitLayersThe same entity as in Lens Scripting.
CameraTypeThe same entity as in Lens Scripting.
CapitalizationOverrideEnum for text capitalization override options.
ClipRangeTypeEnum for specifying clip range units.
CompositionLayerRenderUpdateMode
DeviceTrackingModeThe same entity as in Lens Scripting.
DistanceEffectCurveTypeCurve type options for distance-based effects.
EnvmapFromCameraModeThe same entity as in Lens Scripting.
ExtrudeDirectionSettings used with Editor.Components.Text3D.
EyeToRenderSettings used with Editor.Components.EyeColorVisual.
FaceInsetRegionThe same entity as in Lens Scripting.
FalloffTypeFalloff curve type options for light and effect components.
HeadAttachmentPointTypeSettings used with Editor.Components.Head.
HorizontalOverflowSettings used with Editor.Components.Text and Editor.Components.Text3D.
LightTypeSettings used with Editor.Components.LightSource.
MeshShadowModeThe same entity as in Lens Scripting.
ObjectTrackingTypeSettings used with Editor.Components.ObjectTracking.
ScreenRegionTypeUsed with Editor.Components.ScreenRegionComponent.
ShadowTypeEnum specifying shadow rendering technique for light sources.
SortingTypeUsed with Editor.Components.Canvas.
StretchModeUsed with Editor.Components.BaseMeshVisual.
TextFillModeSettings used with Editor.Components.Text.
TextFillTileZoneSpecifies the coordinate system for text fill tile positioning.
UnitTypeSettings used with Editor.Components.Canvas.
VerticalOverflowSettings used with Editor.Components.Text.