Skip to main content

Class: Interaction

Defined in: src/interaction/Interaction.ts:78

Owns all logical target, hover, capture, completion, and cancellation state.

Constructors​

Constructor​

new Interaction(dependencies): Interaction

Defined in: src/interaction/Interaction.ts:109

Parameters​

dependencies​

InteractionDependencies

Returns​

Interaction

Methods​

cancelObject()​

cancelObject(object, reason): void

Defined in: src/interaction/Interaction.ts:249

Cancels captures that belong to an object before its Script is disposed.

Parameters​

object​

Object3D

reason​

SelectionEndReason = 'removed'

Returns​

void

clear()​

clear(): void

Defined in: src/interaction/Interaction.ts:223

Returns​

void

getIntersectionAt()​

getIntersectionAt(object, controller?): Intersection<Object3D<Object3DEventMap>> | null

Defined in: src/interaction/Interaction.ts:330

Parameters​

object​

Object3D

controller?​

Controller

Returns​

Intersection<Object3D<Object3DEventMap>> | null

getResolvedRay()​

getResolvedRay(controller): ResolvedRay | undefined

Defined in: src/interaction/Interaction.ts:298

Parameters​

controller​

Controller

Returns​

ResolvedRay | undefined

getSourceSnapshot()​

getSourceSnapshot(controller): InteractionSourceState | undefined

Defined in: src/interaction/Interaction.ts:292

Parameters​

controller​

Controller

Returns​

InteractionSourceState | undefined

isHovered()​

isHovered(object): boolean

Defined in: src/interaction/Interaction.ts:321

Parameters​

object​

Object3D

Returns​

boolean

isManipulating()​

isManipulating(object): boolean

Defined in: src/interaction/Interaction.ts:380

Parameters​

object​

Object3D

Returns​

boolean

isPointingAt()​

isPointingAt(object): boolean

Defined in: src/interaction/Interaction.ts:302

Parameters​

object​

Object3D

Returns​

boolean

isSelectingAt()​

isSelectingAt(object): boolean

Defined in: src/interaction/Interaction.ts:309

Parameters​

object​

Object3D

Returns​

boolean

queueScaleIntent()​

queueScaleIntent(controller, factor): boolean

Defined in: src/interaction/Interaction.ts:384

Parameters​

controller​

Controller

factor​

number

Returns​

boolean

registerHitSurface()​

registerHitSurface(physical, logical): () => void

Defined in: src/interaction/Interaction.ts:236

Parameters​

physical​

Object3D

logical​

Object3D

Returns​

(): void

Returns​

void

removeSource()​

removeSource(controller, reason): void

Defined in: src/interaction/Interaction.ts:274

Parameters​

controller​

Controller

reason​

SelectionEndReason = 'source-lost'

Returns​

void

setLongSelectDuration()​

setLongSelectDuration(seconds): void

Defined in: src/interaction/Interaction.ts:132

Parameters​

seconds​

number

Returns​

void

setRaycastMode()​

setRaycastMode(mode): void

Defined in: src/interaction/Interaction.ts:141

Parameters​

mode​

RaycastMode

Returns​

void

syncTouchCandidates()​

syncTouchCandidates(candidates): void

Defined in: src/interaction/Interaction.ts:244

Refreshes bounded direct-touch candidates found by the lifecycle pass.

Parameters​

candidates​

Iterable<Object3D<Object3DEventMap>>

Returns​

void

update()​

update(frame, deltaSeconds): void

Defined in: src/interaction/Interaction.ts:146

Replaces all sampled physical interaction state for one engine frame.

Parameters​

frame​

InteractionFrameInput

deltaSeconds​

number = 0

Returns​

void

writeCursorPointsAt()​

writeCursorPointsAt(object, first, second): 0 | 1 | 2

Defined in: src/interaction/Interaction.ts:351

Writes up to two internal cursor points in controller order.

Parameters​

object​

Object3D

first​

Vector3

second​

Vector3

Returns​

0 | 1 | 2