Skip to main content

SpecsInteractionModule.OverlapProbeOptions

Class

Options supplied when creating an OverlapProbe.

  • Snapchat: not supported
  • SPECS: fully supported
  • Camera Kit Web: not supported
  • Camera Kit Mobile: not supported
  • SnapchatNot supported — Available on SPECS only
  • SPECSFully supported
  • Camera Kit WebNot supported — Available on SPECS only
  • Camera Kit MobileNot supported — Available on SPECS only

Platform details

  • Snapchat — Not supported — Available on SPECS only.

  • SPECS — Fully supported.

  • Camera Kit Web — Not supported — Available on SPECS only.

  • Camera Kit Mobile — Not supported — Available on SPECS only.

Since Lens Scripting v375

Options supplied when creating an OverlapProbe. Optional; omitting it (or any field) uses the defaults.

Index

Example

const options = new SpecsInteractionModule.OverlapProbeOptions();
options.trackDistances = true;
const queryMask = LayerSet.all();
const probe = interaction.createSphereOverlapProbe(script.getSceneObject(), 5, 6, queryMask, options);

Extends

Constructors

Constructor

new OverlapProbeOptions(): OverlapProbeOptions

Returns

OverlapProbeOptions

Overrides

ScriptObject.constructor

Properties

trackDistances

trackDistances: boolean

SPECS

When enabled, the probe refreshes SpecsInteractionModule.Overlap#distance on each member once per frame with the closest-point distance from the collider's volume to the probe center; when disabled (the default), distance stays -1. Costs one closest-point solve per member per frame in the interaction service, so enable it only on probes whose distances you read, and avoid it on probes that can hold many members.

Since

Lens Scripting Version 375

Default Value

false
@snapOS

Methods

getTypeName()

static getTypeName(): TypeName<OverlapProbeOptions>

SPECS

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<OverlapProbeOptions>

Since

Lens Scripting Version 375

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