Lens Scripting API

    This class provides visual feedback by adding an outline to mesh visuals when they are hovered or pinched. It allows customization of the outline color, thickness, and target meshes.

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    Properties

    activatingColor: vec4 = ...

    This is the color of the outline when triggered.

    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.

    enabled: boolean

    If disabled, the Component will stop enacting its behavior.

    hoveringColor: vec4 = ...

    This is the color of the outline when hovered.

    meshVisuals: RenderMeshVisual[] = []

    These are the meshes that will be outlined on pinch/hover.

    name: string
    outlineWeight: number = 0.25

    This is the thickness of the outline.

    sceneObject: SceneObject

    The scene object this component is on.

    targetOutlineMaterial: Material

    This is the material that will provide the mesh outline.

    uniqueIdentifier: string
    updatePriority: number

    Methods

    • Returns void

    • Returns void

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

      Parameters

      • type: string

      Returns boolean

    • Returns void

    • Returns void

    • Returns void

    MMNEPVFCICPMFPCPTTAAATR