Skip to main content

SpecsInteractionModule.Cursor

Class

The latest cursor pose for an interactor.

  • 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

The latest cursor pose for an interactor. See SpecsInteractionModule.Interactor#getCursor. position is in centimeters in world space and opacity is in the range [0, 1].

This is a shared, reused instance. Valid for the current frame only, re-fetch each frame. Copy any value you need to keep beyond the current frame.

Index

Example

const cursor = interactor.getCursor();
if (cursor && cursor.isTracked) {
print("cursor at " + cursor.position + " opacity " + cursor.opacity);
}

Extends

Properties

isTracked

readonly isTracked: boolean

SPECS

Whether the interactor was tracked when this cursor pose was sampled.

Since

Lens Scripting Version 375


opacity

readonly opacity: number

SPECS

Cursor opacity, in the range [0, 1].

Since

Lens Scripting Version 375


position

readonly position: vec3

SPECS

Cursor position, in centimeters, in world space.

Since

Lens Scripting Version 375

Methods

getTypeName()

static getTypeName(): TypeName<Cursor>

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

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