Lens Scripting API

    This class represents a numerical slider control powered by Interaction Kit's hand tracking interactions. It allows users to adjust a value by sliding a handle along a track.

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    Properties

    api: Record<string, any>

    Generic object accessible by other instances of ScriptComponent. Use this object to store references to properties and methods that need to be accessible from other ScriptComponents.

    editEventCallbacks: boolean = false
    enabled: boolean

    If disabled, the Component will stop enacting its behavior.

    name: string
    onHoverEnter: PublicApi<void>
    onHoverExit: PublicApi<void>
    onMaxValueReached: PublicApi<number>
    onMinValueReached: PublicApi<number>
    onSlideEnd: PublicApi<number>
    onSlideStart: PublicApi<number>
    onValueUpdate: PublicApi<number>
    sceneObject: SceneObject

    The scene object this component is on.

    sliderMax: SceneObject

    The position of the slider knob when the maximum value is reached.

    sliderMin: SceneObject
    startValue: number = 0.5

    The initial numeric value of the slider.

    stepBehavior: boolean = false

    Enable this to change the slider's value in steps rather than continuously.

    toggleDuration: number = 0.2

    The duration of the toggle animation in seconds.

    transform: Transform
    uniqueIdentifier: string
    updatePriority: number

    Accessors

    • get currentValue(): number

      Returns number

    • set currentValue(value: number): void

      Parameters

      • value: number

      Returns void

    • get endPosition(): vec3

      Returns vec3

    • set endPosition(position: vec3): void

      Parameters

      Returns void

    • get maxValue(): number

      Returns number

    • set maxValue(value: number): void

      Parameters

      • value: number

      Returns void

    • get minValue(): number

      Returns number

    • set minValue(value: number): void

      Parameters

      • value: number

      Returns void

    • get startPosition(): vec3

      Returns vec3

    • set startPosition(position: vec3): void

      Parameters

      Returns void

    • get stepSize(): number

      Returns number

    • set stepSize(stepSize: number): void

      Parameters

      • stepSize: number

      Returns void

    Methods

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

      Parameters

      • type: string

      Returns boolean

    • Returns void

    • Unsubscribes all the slider-specific callbacks to the Interactable component before this component is destroyed.

      Returns void

    MMNEPVFCICPMFPCPTTAAATR