Classdefault

Base class for all target providers

Hierarchy (view full)

default
- default

Index

Constructors

Properties

_currentInteractableHitInfo camera interactionManager targetingMode

Accessors

currentInteractableHitInfo direction drawDebug endPoint startPoint

Methods

clearCurrentInteractableHitInfo destroy getInteractableHitFromRayCast hasTarget reset update getInteractableHitFromRayCast getNearestDeeplyNestedInteractable

Constructors

constructor

new default(interactor, config): default
Parameters
- interactor: default
- config: IndirectTargetProviderConfig
Returns default
Overrides default.constructor

Properties

`Protected`_currentInteractableHitInfo

_currentInteractableHitInfo: InteractableHitInfo = null

`Protected`camera

camera: default = ...

`Protected`interactionManager

interactionManager: InteractionManager = ...

`Readonly`targetingMode

targetingMode: TargetingMode = TargetingMode.Indirect

Accessors

currentInteractableHitInfo

get currentInteractableHitInfo(): InteractableHitInfo
Returns InteractableHitInfo
the hit information InteractableHitInfo for the current interactable or null if there was no hit

Inherited from TargetProvider.currentInteractableHitInfo

direction

get direction(): vec3
Returns vec3

drawDebug

get drawDebug(): boolean
Returns boolean
set drawDebug(debug): void
Parameters
- debug: boolean
Returns void

endPoint

get endPoint(): vec3
Returns vec3
end position in world space

Overrides TargetProvider.endPoint

startPoint

get startPoint(): vec3
Returns vec3
origin position in world space

Overrides TargetProvider.startPoint

Methods

clearCurrentInteractableHitInfo

clearCurrentInteractableHitInfo(): void
Set the _currentInteractableHitInfo to null, used when an Interactable is deleted from Lens Studio, to keep state in sync

Returns void
Inherited from default.clearCurrentInteractableHitInfo

destroy

destroy(): void
Destroys the provider

Returns void
Overrides default.destroy

`Protected`getInteractableHitFromRayCast

getInteractableHitFromRayCast(hits, offset?, allowOutOfFovInteraction?): InteractableHitInfo
Parameters
- hits: RayCastHit[]
- offset: number = 0
- allowOutOfFovInteraction: boolean = true
Returns InteractableHitInfo
Inherited from default.getInteractableHitFromRayCast

hasTarget

hasTarget(): boolean
Returns boolean
whether the provider has found a target or not

Inherited from default.hasTarget

reset

reset(): void
Can be used to reset inner states Should be called when the hand is not tracked or targeting is blocked

Returns void

update

update(): void
Recomputes the target

Returns void
Overrides default.update

`Static`getInteractableHitFromRayCast

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

Inherited from default.getInteractableHitFromRayCast

`Static`getNearestDeeplyNestedInteractable

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
Inherited from default.getNearestDeeplyNestedInteractable