Lens Scripting API
    Preparing search index...

    Class PinchButton

    This class provides basic pinch button functionality for the prefab pinch button. It is meant to be added to a Scene Object with an Interactable component, with visual behavior configured in the Lens Studio scene.

    in favor of using SpectaclesUIKit's Button components. See https://developers.snap.com/spectacles/spectacles-frameworks/spectacles-ui-kit/get-started for more details.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    api editEventCallbacks enabled isEnabledInHierarchy name onButtonPinched sceneObject uniqueIdentifier updatePriority

    Methods

    createEvent destroy getReferencedEvents getSceneObject getTransform getTypeName getTypeName isOfType isSame onAwake removeEvent

    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.

    This property is no longer needed, you can use a reference to the ScriptComponent, including 'script', directly

    editEventCallbacks: boolean = false

    Enable this to add functions from another script to this component's pinch callback events.

    enabled: boolean

    If disabled, the Component will stop enacting its behavior.

    isEnabledInHierarchy: boolean

    Returns true if this Component, its SceneObject, and all of that SceneObjects parents are enabled.

    name: string
    onButtonPinched: PublicApi<InteractorEvent> = ...
    sceneObject: SceneObject

    The SceneObject this component is on.

    uniqueIdentifier: string
    updatePriority: number

    Methods

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

      Parameters

      • type: string

      Returns boolean

    • Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods