Lens Scripting API

    This class provides visual feedback for a ToggleButton by changing the material of the provided RenderMeshVisuals when the button is toggled on or off.

    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.

    disabledMaterial: Material

    The material applied to the toggle button when it's disabled and cannot be interacted with. This provides visual feedback that the button is currently inactive.

    enabled: boolean

    If disabled, the Component will stop enacting its behavior.

    meshVisuals: RenderMeshVisual[] = []

    An array of RenderMeshVisual components whose materials will be updated to reflect the toggle button's current state.

    name: string
    sceneObject: SceneObject

    The scene object this component is on.

    toggledOffMaterial: Material

    The material applied to the toggle button when it's in the "off" state and not being interacted with. This defines the button's default visual appearance when it's unchecked.

    toggledOffSelectMaterial: Material

    The material applied to the toggle button when it's in the "off" state and being actively triggered. This provides visual feedback during active interaction with an unchecked button.

    toggledOnMaterial: Material

    The material applied to the toggle button when it's in the "on" state and not being interacted with. This defines the button's visual appearance when it's enabled/checked.

    toggledOnSelectMaterial: Material

    The material applied to the toggle button when it's in the "on" state and being actively triggered. This provides visual feedback during active interaction with a checked button.

    uniqueIdentifier: string
    updatePriority: number

    Methods

    • Returns void

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

      Parameters

      • type: string

      Returns boolean

    • Returns void

    MMNEPVFCICPMFPCPTTAAATR