Lens Scripting API
    Preparing search index...

    Interface HandVisuals

    Provides the SceneObject to be attached to the BaseHand

    interface HandVisuals {
        addOverride(override: HandVisualOverride): void;
        glowEffectView: GlowEffectView;
        handMesh: RenderMeshVisual;
        handMeshFull: RenderMeshVisual;
        handMeshIndexThumb: RenderMeshVisual;
        handMeshPin: RenderMeshVisual;
        indexKnuckle: SceneObject;
        indexMidJoint: SceneObject;
        indexTip: SceneObject;
        indexToWrist: SceneObject;
        indexUpperJoint: SceneObject;
        initialize(): void;
        initialized: boolean;
        isVisible: boolean;
        meshType: HandMeshType;
        middleKnuckle: SceneObject;
        middleMidJoint: SceneObject;
        middleTip: SceneObject;
        middleToWrist: SceneObject;
        middleUpperJoint: SceneObject;
        pinkyKnuckle: SceneObject;
        pinkyMidJoint: SceneObject;
        pinkyTip: SceneObject;
        pinkyToWrist: SceneObject;
        pinkyUpperJoint: SceneObject;
        removeOverride(interactableObject: SceneObject): boolean;
        ringKnuckle: SceneObject;
        ringMidJoint: SceneObject;
        ringTip: SceneObject;
        ringToWrist: SceneObject;
        ringUpperJoint: SceneObject;
        root: SceneObject;
        thumbBaseJoint: SceneObject;
        thumbKnuckle: SceneObject;
        thumbMidJoint: SceneObject;
        thumbTip: SceneObject;
        thumbToWrist: SceneObject;
        visualSelection: HandVisualSelection;
        wrist: SceneObject;
    }

    Implemented by

    Index

    Properties

    glowEffectView handMesh handMeshFull handMeshIndexThumb handMeshPin indexKnuckle indexMidJoint indexTip indexToWrist indexUpperJoint initialized isVisible meshType middleKnuckle middleMidJoint middleTip middleToWrist middleUpperJoint pinkyKnuckle pinkyMidJoint pinkyTip pinkyToWrist pinkyUpperJoint ringKnuckle ringMidJoint ringTip ringToWrist ringUpperJoint root thumbBaseJoint thumbKnuckle thumbMidJoint thumbTip thumbToWrist visualSelection wrist

    Methods

    addOverride initialize removeOverride

    Properties

    glowEffectView: GlowEffectView

    The glow effect view that provides visual feedback for hand interactions.

    handMesh: RenderMeshVisual
    handMeshFull: RenderMeshVisual

    Reference to the RenderMeshVisual of the full hand mesh.

    handMeshIndexThumb: RenderMeshVisual

    Reference to the RenderMeshVisual of the hand mesh with only an index & thumb for efficiency.

    handMeshPin: RenderMeshVisual

    Reference to the RenderMeshVisual of the full hand mesh to pin SceneObjects to.

    indexKnuckle: SceneObject

    The SceneObject of the indexKnuckle joint

    indexMidJoint: SceneObject

    The SceneObject of the indexMidJoint joint

    indexTip: SceneObject

    The SceneObject of the indexTip joint

    indexToWrist: SceneObject

    The SceneObject of the indexToWrist joint

    indexUpperJoint: SceneObject

    The SceneObject of the indexUpperJoint joint

    initialized: boolean

    True when this class is ready to use.

    initialize can be used to initialize the instance.

    isVisible: boolean

    Gets or sets whether the hand visual is visible. When false, all hand visual components (mesh, glow effects, and wrist) will not be shown regardless of tracking status.

    meshType: HandMeshType

    Gets or sets the mesh type to display (Full or IndexThumb)

    middleKnuckle: SceneObject

    The SceneObject of the middleKnuckle joint

    middleMidJoint: SceneObject

    The SceneObject of the middleMidJoint joint

    middleTip: SceneObject

    The SceneObject of the middleTip joint

    middleToWrist: SceneObject

    The SceneObject of the middleToWrist joint

    middleUpperJoint: SceneObject

    The SceneObject of the middleUpperJoint joint

    pinkyKnuckle: SceneObject

    The SceneObject of the pinkyKnuckle joint

    pinkyMidJoint: SceneObject

    The SceneObject of the pinkyMidJoint joint

    pinkyTip: SceneObject

    The SceneObject of the pinkyTip joint

    pinkyToWrist: SceneObject

    The SceneObject of the pinkyToWrist joint

    pinkyUpperJoint: SceneObject

    The SceneObject of the pinkyUpperJoint joint

    ringKnuckle: SceneObject

    The SceneObject of the ringKnuckle joint

    ringMidJoint: SceneObject

    The SceneObject of the ringMidJoint joint

    ringTip: SceneObject

    The SceneObject of the ringTip joint

    ringToWrist: SceneObject

    The SceneObject of the ringToWrist joint

    ringUpperJoint: SceneObject

    The SceneObject of the ringUpperJoint joint

    root: SceneObject

    The root SceneObject, parent of the hand rig and hand mesh

    thumbBaseJoint: SceneObject

    The SceneObject of the thumbBaseJoint joint

    thumbKnuckle: SceneObject

    The SceneObject of the thumbKnuckle joint

    thumbMidJoint: SceneObject

    The SceneObject of the thumbMidJoint joint

    thumbTip: SceneObject

    The SceneObject of the thumbTip joint

    thumbToWrist: SceneObject

    The SceneObject of the thumbToWrist joint

    visualSelection: HandVisualSelection

    Sets the selection of the hand visual to present to user

    wrist: SceneObject

    The SceneObject of the wrist joint

    Methods

    • Adds a hand visual override for a specific interactable.

      Parameters

      Returns void

    • Removes a hand visual override by its interactable SceneObject.

      Parameters

      • interactableObject: SceneObject

        The SceneObject of the override to remove.

      Returns boolean

      True if removed, false if not found.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods