Skip to main content

SpecsInteractionModule.DebugVisualizerOptions

Class

Which debug visualizers the interaction system draws for this Lens's interaction content.

  • 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 v387

Which debug visualizers the interaction system draws for this Lens's interaction content. Every visualizer is off by default. Pass the options to SpecsInteractionModule#setDebugVisualizerOptions.

Index

Example

const options = new SpecsInteractionModule.DebugVisualizerOptions();
options.showColliders = true;
options.showQueries = true;
interaction.setDebugVisualizerOptions(options);

Constructors

Constructor

new DebugVisualizerOptions(): DebugVisualizerOptions

Returns

DebugVisualizerOptions

Properties

showColliders

showColliders: boolean

SPECS

Wireframes for this Lens's registered Interactable colliders.

Since

Lens Scripting Version 387

Default Value

false
@snapOS

showCursor

showCursor: boolean

SPECS

Markers showing how the interaction system determines the current cursor location.

Since

Lens Scripting Version 387

Default Value

false
@snapOS

showInteractionPlanes

showInteractionPlanes: boolean

SPECS

InteractionPlane boundaries and interaction zones.

Since

Lens Scripting Version 387

Default Value

false
@snapOS

showOverlapProbes

showOverlapProbes: boolean

SPECS

Overlap probe enter and exit volumes.

Since

Lens Scripting Version 387

Default Value

false
@snapOS

showQueries

showQueries: boolean

SPECS

Ray and sphere casts, with their hit markers.

Since

Lens Scripting Version 387

Default Value

false
@snapOS

Methods

getTypeName()

static getTypeName(): TypeName<DebugVisualizerOptions>

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

Since

Lens Scripting Version 387