Class defaultAbstract

constructor

• new default(): default

  Returns default

Protected_currentInteractableHitInfo

Protectedcamera

ProtectedinteractionManager

Abstract ReadonlytargetingMode

currentInteractableHitInfo

• get currentInteractableHitInfo(): InteractableHitInfo

  Returns InteractableHitInfo

  the hit information InteractableHitInfo for the current interactable or null if there was no hit

AbstractendPoint

• get endPoint(): vec3

  Returns vec3

  end position in world space

AbstractstartPoint

• get startPoint(): vec3

  Returns vec3

  origin position in world space

clearCurrentInteractableHitInfo

• clearCurrentInteractableHitInfo(): void

  Set the _currentInteractableHitInfo to null, used when an Interactable is deleted from Lens Studio, to keep state in sync

  Returns void

ProtecteddeleteFromCurrentInteractableSet

• deleteFromCurrentInteractableSet(interactable: Interactable): void

  Parameters

  • interactable: Interactable

  Returns void

Abstractdestroy

• destroy(): void

  Destroys the provider

  Returns void

StaticgetInteractableHitFromRayCast

• getInteractableHitFromRayCast(
      hits: RayCastHit[],
      targetingMode: TargetingMode,
      getInteractableByCollider: (collider: ColliderComponent) => Interactable,
      offset?: number,
      camera?: default,
      allowOutOfFovInteraction?: boolean,
  ): InteractableHitInfo

  Parameters

  • hits: RayCastHit[]

    list of RayCastHit
  • targetingMode: TargetingMode

    targeting mode used to filter hits
  • getInteractableByCollider: (collider: ColliderComponent) => Interactable

    function that is used to get the interactable associated to the collider (to enable the method to be static)
  • offset: number = 0

    offset value that defines if the raycast was offset from the start point
  • camera: default = null

    camera used to verify FoV
  • allowOutOfFovInteraction: boolean = false

    whether interactions that are out of the camera's field of view are allowed

  Returns InteractableHitInfo

  the hit corresponding to the target from the list of hits

ProtectedgetInteractableHitFromRayCast

• getInteractableHitFromRayCast(
      hits: RayCastHit[],
      offset?: number,
      allowOutOfFovInteraction?: boolean,
  ): InteractableHitInfo

  Parameters

  • hits: RayCastHit[]
  • offset: number = 0
  • allowOutOfFovInteraction: boolean = false

  Returns InteractableHitInfo

StaticgetNearestDeeplyNestedInteractable

• getNearestDeeplyNestedInteractable(
      hitInfos: InteractableHitInfo[],
  ): InteractableHitInfo

  The nearest deeply nested interactable, is the latest descendant of a list of interactables, when they are ordered by distance.

  Parameters

  • hitInfos: InteractableHitInfo[]

    list of hits

  Returns InteractableHitInfo

  • the most deeply nested interactable of the nearest interactable

hasTarget

• hasTarget(): boolean

  Returns boolean

  whether the provider has found a target or not

isIntersectingInteractable

• isIntersectingInteractable(interactable: Interactable): boolean

  Parameters

  • interactable: Interactable

  Returns boolean

  whether the TargetProvider is intersecting with the Interactable

Abstractupdate

• update(): void

  Recomputes the target

  Returns void

ProtectedupdateCurrentInteractableSet

• updateCurrentInteractableSet(hits: RayCastHit[]): void

  Parameters

  • hits: RayCastHit[]

  Returns void