Lens Scripting API
    Preparing search index...

    Class Cursor

    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.

    Lens Scripting Version 375

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

    Hierarchy (View Summary)

    Index

    Properties

    isTracked opacity position

    Methods

    getTypeName getTypeName isOfType isSame

    Properties

    isTracked: boolean

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

    Lens Scripting Version 375

    opacity: number

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

    Lens Scripting Version 375

    position: vec3

    Cursor position, in centimeters, in world space.

    Lens Scripting Version 375

    Methods

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

      Lens Scripting Version 375

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

      Parameters

      • type: string

      Returns boolean

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

      Parameters

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Properties
    Methods