Skip to main content

Assets

Assets are resources imported into Lens Studio. See also: Importing and Updating Resources Guide

AnimationLayer​

Configures an animation layer for a single SceneObject. Gives access to position, rotation, scale and blend shape animation tracks. See also: Playing 3D Animation Guide, AnimationMixer, Animation.

Lens Studio v1.0.0+
Scripting Name: Asset.AnimationLayer
Inherits from AnimationTrack

This is the API for Lens Studio 4. For the latest API documentation, click here.

AnimationTrack​

The base class for animation tracks.

Lens Studio v1.0.0+
Scripting Name: Asset.AnimationTrack
Inherits from Asset

This is the API for Lens Studio 4. For the latest API documentation, click here.

Asset​

Base class for all assets used in the engine.

Lens Studio v1.0.0+
Scripting Name: Asset
Inherits from SerializableWithUID

This is the API for Lens Studio 4. For the latest API documentation, click here.

AudioEffectAsset​

Configures an audio effect for AudioEffectComponent.

Lens Studio v1.7.0+
Scripting Name: Asset.AudioEffectAsset
Inherits from Asset

This is the API for Lens Studio 4. For the latest API documentation, click here.

AudioTrackAsset​

Represents an audio file asset. See also: AudioComponent.

Lens Studio v1.0.0+
Scripting Name: Asset.AudioTrackAsset
Inherits from Asset

This is the API for Lens Studio 4. For the latest API documentation, click here.

BinAsset​

File based asset.

Lens Studio v1.7.0+
Scripting Name: Asset.BinAsset
Inherits from Asset

This is the API for Lens Studio 4. For the latest API documentation, click here.

BitmojiModule​

Provides access to getting information about the current user's Bitmoji.

Lens Studio v4.22.0+
Scripting Name: Asset.BitmojiModule
Inherits from Asset

This is the API for Lens Studio 4. For the latest API documentation, click here.

BodyTrackingAsset​

Asset used to configure Body Tracking for the ObjectTracking3D component.

Lens Studio v3.4+
Scripting Name: Asset.BodyTrackingAsset
Inherits from Object3DAsset

This is the API for Lens Studio 4. For the latest API documentation, click here.

CloudStorageModule​

Provides access to Cloud Storage.

Lens Studio v4.19.0+
Scripting Name: Asset.CloudStorageModule
Inherits from Asset

This is the API for Lens Studio 4. For the latest API documentation, click here.

CollisionMesh​

Lens Studio v4.53.0+
Scripting Name: Physics.CollisionMesh
Inherits from Asset

This is the API for Lens Studio 4. For the latest API documentation, click here.

ConnectedLensModule​

Connected Lenses Module allows use of networked Lens communication capabilities (real-time communication, co-located session creation and joining, and shared persistent storage). It's recommended to only use one ConnectedLensModule per Lens.

Lens Studio v4.0+
Scripting Name: Asset.ConnectedLensModule
Inherits from Asset

This is the API for Lens Studio 4. For the latest API documentation, click here.

DeformingCollisionMesh​

Lens Studio v4.53.0+
Scripting Name: Physics.DeformingCollisionMesh
Inherits from CollisionMesh

This is the API for Lens Studio 4. For the latest API documentation, click here.

DialogModule​

Lens Studio v4.28.0+
Scripting Name: Asset.DialogModule
Inherits from Asset

This is the API for Lens Studio 4. For the latest API documentation, click here.

FixedCollisionMesh​

Lens Studio v4.53.0+
Scripting Name: Physics.FixedCollisionMesh
Inherits from CollisionMesh

This is the API for Lens Studio 4. For the latest API documentation, click here.

FloatAnimationTrack​

The base class for animation tracks using float values.

Lens Studio v1.0.0+
Scripting Name: Asset.FloatAnimationTrack
Inherits from AnimationTrack

This is the API for Lens Studio 4. For the latest API documentation, click here.

FloatAnimationTrackKeyFramed​

Represents an animation track using float value keyframes.

Lens Studio v1.0.0+
Scripting Name: Asset.FloatAnimationTrackKeyFramed
Inherits from FloatAnimationTrack

This is the API for Lens Studio 4. For the latest API documentation, click here.

FloatBezierAnimationTrackKeyFramed​

Represents an animation track using vec3 value keyframes for a bezier curve.

Lens Studio v1.0.0+
Scripting Name: Asset.FloatBezierAnimationTrackKeyFramed
Inherits from FloatAnimationTrack

This is the API for Lens Studio 4. For the latest API documentation, click here.

Font​

A font asset used for rendering text. Used by Text. For more information, see the Text guide.

Lens Studio v1.7.0+
Scripting Name: Asset.Font
Inherits from Asset

This is the API for Lens Studio 4. For the latest API documentation, click here.

GltfAsset​

Represents a GLTF 3D Model.

Lens Studio v4.22.0+
Scripting Name: Asset.GltfAsset
Inherits from Asset

This is the API for Lens Studio 4. For the latest API documentation, click here.

HairDataAsset​

Hair asset converted from an FBX containing splines to be used with Hair Visual.

Lens Studio v4.0+
Scripting Name: Asset.HairDataAsset
Inherits from Asset

This is the API for Lens Studio 4. For the latest API documentation, click here.

HandTracking3DAsset​

Lens Studio v4.7+
Scripting Name: Asset.HandTracking3DAsset
Inherits from Object3DAsset

This is the API for Lens Studio 4. For the latest API documentation, click here.

IntAnimationTrack​

The base class for animation tracks using integer values.

Lens Studio v1.0.0+
Scripting Name: Asset.IntAnimationTrack
Inherits from AnimationTrack

This is the API for Lens Studio 4. For the latest API documentation, click here.

IntStepAnimationTrackKeyFramed​

Represents an animation track using stepped integer value keyframes.

Lens Studio v1.0.0+
Scripting Name: Asset.IntStepAnimationTrackKeyFramed
Inherits from IntAnimationTrack

This is the API for Lens Studio 4. For the latest API documentation, click here.

IntStepNoLerpAnimationTrackKeyFramed​

Represents an animation track using stepped integer value keyframes.

Lens Studio v2.0.0+
Scripting Name: Asset.IntStepNoLerpAnimationTrackKeyFramed
Inherits from IntAnimationTrack

This is the API for Lens Studio 4. For the latest API documentation, click here.

LevelsetColliderAsset​

Collider asset generated from a mesh to be used with the Hair Visual as part of the hair simulation.

Lens Studio v4.1+
Scripting Name: Asset.LevelsetColliderAsset
Inherits from BinAsset

This is the API for Lens Studio 4. For the latest API documentation, click here.

LocalizationsAsset​

Asset used with the Localizations system to support custom localization strings.

Lens Studio v4.1+
Scripting Name: Asset.LocalizationsAsset
Inherits from Asset

This is the API for Lens Studio 4. For the latest API documentation, click here.

LocationAsset​

Provides a frame of reference in which to localize objects to the real world. Use with LocatedAtComponent.

Lens Studio v2.0.0+
Scripting Name: Asset.LocationAsset
Inherits from Asset

This is the API for Lens Studio 4. For the latest API documentation, click here.

LocationCloudStorageModule​

Provides access to location cloud storage depending upon the LocationCloudStorageOptions.

Lens Studio v4.28.0+
Scripting Name: Asset.LocationCloudStorageModule
Inherits from Asset

This is the API for Lens Studio 4. For the latest API documentation, click here.

MLAsset​

Binary ML model supplied by the user.

Lens Studio v3.0+
Scripting Name: Asset.MLAsset
Inherits from BinAsset

This is the API for Lens Studio 4. For the latest API documentation, click here.

MarkerAsset​

Defines a marker to use for Marker Tracking with MarkerTrackingComponent. For more information, see the Marker Tracking guide.

Lens Studio v1.7.0+
Scripting Name: Asset.MarkerAsset
Inherits from Asset

This is the API for Lens Studio 4. For the latest API documentation, click here.

Material​

An asset that describes how visual objects should appear. Each Material is a collection of Passes which define the actual rendering passes. Materials are used by MeshVisuals for drawing meshes in the scene.

Lens Studio v1.0.0+
Scripting Name: Asset.Material
Inherits from Asset

This is the API for Lens Studio 4. For the latest API documentation, click here.

Matter​

Settings for the physical substance, such as friction and bounciness, of a collider. If unset, uses the default matter from the world settings.

Lens Studio v4.13.0+
Scripting Name: Physics.Matter
Inherits from Asset

This is the API for Lens Studio 4. For the latest API documentation, click here.

Object3DAsset​

Base class for configuring object tracking in the ObjectTracking3D component.

Lens Studio v3.4+
Scripting Name: Asset.Object3DAsset
Inherits from Asset

This is the API for Lens Studio 4. For the latest API documentation, click here.

ObjectPrefab​

A reusable object hierarchy stored as a resource. Can be instantiated through script or brought into the scene through Lens Studio. For more information, see the Prefabs guide.

Lens Studio v1.7.0+
Scripting Name: Asset.ObjectPrefab
Inherits from Asset

This is the API for Lens Studio 4. For the latest API documentation, click here.

QuaternionAnimationTrack​

The base class for animation tracks using quaternion values.

Lens Studio v1.0.0+
Scripting Name: Asset.QuaternionAnimationTrack
Inherits from AnimationTrack

This is the API for Lens Studio 4. For the latest API documentation, click here.

QuaternionAnimationTrackKeyFramed​

Represents an animation track using quaternion value keyframes.

Lens Studio v1.0.0+
Scripting Name: Asset.QuaternionAnimationTrackKeyFramed

This is the API for Lens Studio 4. For the latest API documentation, click here.

QuaternionAnimationTrackXYZEuler​

Represents a rotation animation track using euler angles.

Lens Studio v1.0.0+
Scripting Name: Asset.QuaternionAnimationTrackXYZEuler

This is the API for Lens Studio 4. For the latest API documentation, click here.

RemoteMediaModule​

Provides access to a remote media.

Lens Studio v4.22.0+
Scripting Name: Asset.RemoteMediaModule
Inherits from Asset

This is the API for Lens Studio 4. For the latest API documentation, click here.

RemoteReferenceAsset​

Provides a reference to a remote asset (i.e. assets outside of the Lens size limit) that can be downloaded at runtime using script.

Lens Studio v4.31.0+
Scripting Name: Asset.RemoteReferenceAsset
Inherits from Asset

This is the API for Lens Studio 4. For the latest API documentation, click here.

RemoteServiceModule​

Lens Studio v4.0+
Scripting Name: Asset.RemoteServiceModule
Inherits from Asset

This is the API for Lens Studio 4. For the latest API documentation, click here.

RenderMesh​

Represents a mesh asset. See also: RenderMeshVisual.

Lens Studio v1.0.0+
Scripting Name: Asset.RenderMesh
Inherits from Asset

This is the API for Lens Studio 4. For the latest API documentation, click here.

[Exposes User Data] ScanModule​

Asset for detecting an object through the Scan system.

Lens Studio v3.4+
Scripting Name: Asset.ScanModule
Inherits from Asset
Inner Classes: ScanModule.Contexts

This is the API for Lens Studio 4. For the latest API documentation, click here.

ScriptAsset​

Represents a JavaScript script which can be used to add logic in your Lens.

Lens Studio v4.22.0+
Scripting Name: Asset.ScriptAsset
Inherits from Asset

This is the API for Lens Studio 4. For the latest API documentation, click here.

SegmentationModel​

Segmentation model used for SegmentationTextureProvider.

Lens Studio v1.7.0+
Scripting Name: Asset.SegmentationModel
Inherits from BinAsset

This is the API for Lens Studio 4. For the latest API documentation, click here.

TextToSpeechModule​

Allows generation of speech from a given text. You can use only one TextToSpeechModule in a Lens. However, its methods can be called multiple times in parallel if needed.

Lens Studio v4.4+
Scripting Name: Asset.TextToSpeechModule
Inherits from Asset

This is the API for Lens Studio 4. For the latest API documentation, click here.

Texture​

Represents a texture file asset.

Lens Studio v1.0.0+
Scripting Name: Asset.Texture
Inherits from Asset

This is the API for Lens Studio 4. For the latest API documentation, click here.

VFXAsset​

Defines a VFX to use with VFX Component. For more information, see the VFX Guide.

Lens Studio v4.0+
Scripting Name: Asset.VFXAsset
Inherits from Asset

This is the API for Lens Studio 4. For the latest API documentation, click here.

Vec2AnimationTrack​

Represents an animation track using vec2 value keyframes.

Lens Studio v1.0.0+
Scripting Name: Asset.Vec2AnimationTrack
Inherits from AnimationTrack

This is the API for Lens Studio 4. For the latest API documentation, click here.

Vec2AnimationTrackKeyFramed​

Represents an animation track using vec2 value keyframes.

Lens Studio v1.0.0+
Scripting Name: Asset.Vec2AnimationTrackKeyFramed
Inherits from Vec2AnimationTrack

This is the API for Lens Studio 4. For the latest API documentation, click here.

Vec3AnimationTrack​

Represents an animation track using vec3 value keyframes.

Lens Studio v1.0.0+
Scripting Name: Asset.Vec3AnimationTrack
Inherits from AnimationTrack

This is the API for Lens Studio 4. For the latest API documentation, click here.

Vec3AnimationTrackKeyFramed​

Represents an animation track using vec3 value keyframes.

Lens Studio v1.0.0+
Scripting Name: Asset.Vec3AnimationTrackKeyFramed
Inherits from Vec3AnimationTrack

This is the API for Lens Studio 4. For the latest API documentation, click here.

Vec3AnimationTrackXYZ​

Represents an animation track using vec3 animation tracks.

Lens Studio v1.0.0+
Scripting Name: Asset.Vec3AnimationTrackXYZ
Inherits from Vec3AnimationTrack

This is the API for Lens Studio 4. For the latest API documentation, click here.

Vec4AnimationTrack​

Represents an animation track using vec4 value keyframes.

Lens Studio v1.0.0+
Scripting Name: Asset.Vec4AnimationTrack
Inherits from AnimationTrack

This is the API for Lens Studio 4. For the latest API documentation, click here.

Vec4AnimationTrackKeyFramed​

Represents an animation track using vec4 value keyframes.

Lens Studio v1.0.0+
Scripting Name: Asset.Vec4AnimationTrackKeyFramed
Inherits from Vec4AnimationTrack

This is the API for Lens Studio 4. For the latest API documentation, click here.

VoiceMLModule​

VoiceML Module allows voice input and commands. It enables transciption of the speech, detecting keywords within the transcription, intents as well as system commands (such as "Take a Snap"). You can use one VoiceML Module per Lens.

Lens Studio v4.4+
Scripting Name: Asset.VoiceMLModule
Inherits from Asset

This is the API for Lens Studio 4. For the latest API documentation, click here.

WorldSettingsAsset​

Stores reusable settings uniform for a world (such as gravity magnitude and direction). See also: WorldComponent.worldSettings.

Lens Studio v4.10.0+
Scripting Name: Physics.WorldSettingsAsset
Inherits from Asset

This is the API for Lens Studio 4. For the latest API documentation, click here.

Was this page helpful?
Yes
No