Lens Scripting API
    Preparing search index...

    Class InteractionPlaneOptions

    Options supplied when registering an interaction plane.

    Lens Scripting Version 375

    const options = new SpecsInteractionModule.InteractionPlaneOptions();
    options.planeSize = new vec2(20, 20);
    interaction.registerInteractionPlane(script.getSceneObject(), options);
    Index

    Constructors

    constructor

    Properties

    behindZoneDepth nearFieldDepth offset physicalZoneDepth planeSize targetingVisual

    Methods

    getTypeName

    Constructors

    Properties

    behindZoneDepth: number

    The depth (in centimeters) of the tolerance zone behind the plane. Interactions are still detected when the hand accidentally pushes through the plane, up to this distance.

    Lens Scripting Version 375

    15
    nearFieldDepth: number

    The depth (in centimeters) of the near-field interaction zone along the plane's local Z axis. A hand within this distance in front of the plane uses near-field targeting; beyond it, standard far-field ray targeting applies. Exiting the zone uses a slightly larger threshold than entering to prevent flickering at the boundary.

    Lens Scripting Version 375

    17
    offset: vec3

    Local-space offset of the plane. Allows positioning the effective interaction plane relative to the host SceneObject.

    Lens Scripting Version 375

    (0, 0, 0)
    physicalZoneDepth: number

    The depth (in centimeters) of the physical interaction zone in front of the plane. Within this distance, physical interactions (poke and direct pinch) are enabled. Exiting the zone uses a slightly larger threshold than entering to prevent flickering at the boundary.

    Lens Scripting Version 375

    3
    planeSize: vec2

    The size of the interaction plane along the local X and Y axes. Defines the rectangular area of the plane where hand interactions are detected. Larger values create a bigger interactive surface area.

    Lens Scripting Version 375

    (10, 10)
    targetingVisual: SpecsInteractionModule.TargetingVisual

    The targeting visual shown while an interactor targets this InteractionPlane.

    Lens Scripting Version 375

    SpecsInteractionModule.TargetingVisual.Cursor

    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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods