Skip to main content

WorldOptions

Class

Holds settings for world mesh and point cloud tracking in DeviceTracking component.

  • Available on all platforms
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

Holds settings for world mesh and point cloud tracking in DeviceTracking component. Accessible through DeviceTracking.worldOptions. When tracking either world meshes or point clouds, the DeviceTracking component must be set to World mode.

Index

Extends

Properties

enablePlaneClassification

enablePlaneClassification: boolean

SPECS only

Enables or disables semantic classification of tracked planes, see TrackedPlane#classification. Changing it removes the existing planes, which are then detected again.

Since

Lens Scripting Version 387

Default Value

false
@wearableOnly

enableWorldMeshesClassificationTracking

enableWorldMeshesClassificationTracking: boolean

Enables or disables world mesh classification gathering.

Default Value

false

enableWorldMeshesTracking

enableWorldMeshesTracking: boolean

Enables or disables the generation of world meshes.

Default Value

false

nativePlaneTrackingType

nativePlaneTrackingType: NativePlaneTrackingType

Since

Lens Scripting Version 144

Default Value

NativePlaneTrackingType.None

pointCloudEnabled

pointCloudEnabled: boolean

Enables or disables point cloud tracking.

Since

Lens Scripting Version 148

Default Value

false

Methods

getTypeName()

static getTypeName(): TypeName<WorldOptions>

Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

Returns

TypeName<WorldOptions>

Overrides

ScriptObject.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

ScriptObject.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object matches or derives from the passed in type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

ScriptObject.isOfType


isSame()

isSame(other): boolean

Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

ScriptObject.isSame