ClassDirectTargetProvider

Protected_currentInteractableHitInfo

Protectedcamera

Protectedconfig

ProtectedinteractionManager

Protectedinteractor

ProtectedownerSceneObject

colliderPosition

• get colliderPosition(): vec3

• Returns vec3

  the direct collider position for direct manipulation

currentInteractableHitInfo

• get currentInteractableHitInfo(): InteractableHitInfo

• Returns InteractableHitInfo

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

endPoint

• get endPoint(): vec3

• Returns vec3

  end position in world space

startPoint

• 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

ProtectedcreateCollider

• createCollider(sceneObject, radius, onOverlapStay, onOverlapExit, debugDrawEnabled): ColliderComponent

• Parameters

  • sceneObject: SceneObject
  • radius: number
  • onOverlapStay: ((eventArgs: OverlapStayEventArgs) => void)
    • • (eventArgs): void

      • Parameters

        • eventArgs: OverlapStayEventArgs

        Returns void

  • onOverlapExit: ((eventArgs: OverlapExitEventArgs) => void)
    • • (eventArgs): void

      • Parameters

        • eventArgs: OverlapExitEventArgs

        Returns void

  • debugDrawEnabled: boolean

  Returns ColliderComponent

destroy

• destroy(): void

• Destroys the provider

  Returns void

ProtectedgetInteractableHitFromRayCast

• getInteractableHitFromRayCast(hits, offset?, allowOutOfFovInteraction?): InteractableHitInfo

• Parameters

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

  Returns InteractableHitInfo

hasTarget

• hasTarget(): boolean

• Returns boolean

  whether the provider has found a target or not

StaticgetInteractableHitFromRayCast

• getInteractableHitFromRayCast(hits, targetingMode, getInteractableByCollider, offset?, camera?, allowOutOfFovInteraction?): 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)

    • • (collider): Interactable

      • Parameters

        • collider: ColliderComponent

        Returns Interactable

  • 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 = true

    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

StaticgetNearestDeeplyNestedInteractable

• getNearestDeeplyNestedInteractable(hitInfos): 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 nearest deeply nested interactable