Class: Interaction
Defined in: src/interaction/Interaction.ts:96
Owns all logical target, hover, capture, completion, and cancellation state.
Constructors
Constructor
new Interaction(
dependencies):Interaction
Defined in: src/interaction/Interaction.ts:129
Parameters
dependencies
InteractionDependencies
Returns
Interaction
Methods
cancelObject()
cancelObject(
object,reason):void
Defined in: src/interaction/Interaction.ts:288
Cancels captures that belong to an object before its Script is disposed.
Parameters
object
reason
SelectionEndReason = 'removed'
Returns
void
clear()
clear():
void
Defined in: src/interaction/Interaction.ts:255
Returns
void
getIntersectionAt()
getIntersectionAt(
object,controller?):Intersection<Object3D<Object3DEventMap>> |null
Defined in: src/interaction/Interaction.ts:375
Parameters
object
controller?
Controller
Returns
Intersection<Object3D<Object3DEventMap>> | null
getResolvedRay()
getResolvedRay(
controller):ResolvedRay|undefined
Defined in: src/interaction/Interaction.ts:338
Parameters
controller
Controller
Returns
ResolvedRay | undefined
getSourceSnapshot()
getSourceSnapshot(
controller):InteractionSourceState|undefined
Defined in: src/interaction/Interaction.ts:332
Parameters
controller
Controller
Returns
InteractionSourceState | undefined
isHovered()
isHovered(
object):boolean
Defined in: src/interaction/Interaction.ts:366
Parameters
object
Returns
boolean
isManipulating()
isManipulating(
object):boolean
Defined in: src/interaction/Interaction.ts:425
Parameters
object
Returns
boolean
isPointingAt()
isPointingAt(
object):boolean
Defined in: src/interaction/Interaction.ts:342
Parameters
object
Returns
boolean
isSelectingAt()
isSelectingAt(
object):boolean
Defined in: src/interaction/Interaction.ts:349
Parameters
object
Returns
boolean
queueScaleIntent()
queueScaleIntent(
controller,factor):boolean
Defined in: src/interaction/Interaction.ts:429
Parameters
controller
Controller
factor
number
Returns
boolean
queueWheelIntent()
queueWheelIntent(
controller,delta):boolean
Defined in: src/interaction/Interaction.ts:439
Routes a normalized wheel delta using the next frame's resolved target.
Parameters
controller
Controller
delta
number
Returns
boolean
registerHitSurface()
registerHitSurface(
physical,logical,options?): () =>void
Defined in: src/interaction/Interaction.ts:269
Parameters
physical
logical
options?
Returns
():
void
Returns
void
removeSource()
removeSource(
controller,reason):void
Defined in: src/interaction/Interaction.ts:313
Parameters
controller
Controller
reason
SelectionEndReason = 'source-lost'
Returns
void
setLongSelectDuration()
setLongSelectDuration(
seconds):void
Defined in: src/interaction/Interaction.ts:153
Parameters
seconds
number
Returns
void
setRaycastMode()
setRaycastMode(
mode):void
Defined in: src/interaction/Interaction.ts:162
Parameters
mode
Returns
void
setSelectionFocusHandler()
setSelectionFocusHandler(
handler?):void
Defined in: src/interaction/Interaction.ts:278
Installs the UI runtime's focus policy without owning a second input path.
Parameters
handler?
(target?) => void
Returns
void
syncTouchCandidates()
syncTouchCandidates(
candidates):void
Defined in: src/interaction/Interaction.ts:283
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:167
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:396
Writes up to two internal cursor points in controller order.
Parameters
object
first
second
Returns
0 | 1 | 2