Class Interactor

Manages interaction capabilities of a VR controller or a similar input device.

The Interactor class enables an entity to grip or interact with objects that implement the Interactable interface.

Hierarchy

  • Component
    • Interactor

Properties

inputObject meshRoot onGrabEnd onGrabStart trackedSpace visualStateOnGrab TypeName

Accessors

input interactable

Methods

checkForNearbyInteractables onActivate onDeactivate onPhysxCollision start startInteraction stopInteraction onRegister

Properties

inputObject

inputObject: Object3D

Properties

meshRoot

meshRoot: null | Object3D = null

onGrabEnd

onGrabEnd: Emitter<[Interactor, Grabbable]> = ...

Notifies once a grabbable is released.

Note

The notification occurs after the grabbable one.

onGrabStart

onGrabStart: Emitter<[Interactor, Grabbable]> = ...

Notifies once a grabbable is grabbed.

Note

The notification occurs after the grabbable one.

trackedSpace

trackedSpace: Object3D = ...

visualStateOnGrab

visualStateOnGrab: InteractorVisualState = InteractorVisualState.Visible

Static TypeName

TypeName: string = 'interactor'

Accessors

input

interactable

Methods

checkForNearbyInteractables

  • checkForNearbyInteractables(): void

  • Check for nearby interactable, and notifies one if this interactor interacts with it.

    Returns void

onActivate

onDeactivate

onPhysxCollision

start

  • start(): void

  • Set the collision component needed to perform grab interaction

    Returns void

    This instance, for chaining

startInteraction

  • startInteraction(interactable, handleId): void

  • Force this interactor to start interacting with the given interactable.

    Parameters

    • interactable: Grabbable

      The interactable to process.

    • handleId: number

    Returns void

stopInteraction

Static onRegister

Settings

Theme

On This Page