Interface MouseEventReceiverInterface

Mouse and touch events

Hierarchy

MouseEventReceiverInterface

Index

Methods

onClick? onDoubleClick? onDrag? onDragCancel? onDragEnd? onDragStart? onHold? onMouseMove? onMouseOut? onMouseOver? onMouseWheel?

Methods

`Optional` onClick

onClick(pos: MouseEventCoordinatesInterface, instanceId?: number): boolean
Called for mouse clicks and taps

Returns
Return true to consume the event, false to pass it on
Parameters
- pos: MouseEventCoordinatesInterface
  
  Mouse position
- Optional instanceId: number
  
  The index of the instance if the event occurred on an InstancedMesh.
Returns boolean

`Optional` onDoubleClick

onDoubleClick(pos: MouseEventCoordinatesInterface, instanceId?: number): boolean
Called for double clicks and double taps

Returns
Return true to consume the event, false to pass it on
Parameters
- pos: MouseEventCoordinatesInterface
  
  Mouse position
- Optional instanceId: number
  
  The index of the instance if the event occurred on an InstancedMesh.
Returns boolean

`Optional` onDrag

onDrag(position: MouseEventCoordinatesInterface, viewport: ViewportInterface, instanceId?: number): void
Called during dragging
Parameters
- position: MouseEventCoordinatesInterface
  
  Mouse position
- viewport: ViewportInterface
  
  The current viewport
- Optional instanceId: number
  
  The index of the instance if the event occurred on an InstancedMesh.
Returns void

`Optional` onDragCancel

onDragCancel(instanceId?: number): void
Called when the user cancels dragging by pressing the escape key
Parameters
- Optional instanceId: number
  
  The index of the instance if the event occurred on an InstancedMesh.
Returns void

`Optional` onDragEnd

onDragEnd(position: MouseEventCoordinatesInterface, viewport: ViewportInterface, instanceId?: number): void
Called when the user releases the mouse button after dragging
Parameters
- position: MouseEventCoordinatesInterface
- viewport: ViewportInterface
- Optional instanceId: number
  
  The index of the instance if the event occurred on an InstancedMesh.
Returns void

`Optional` onDragStart

onDragStart(position: MouseEventCoordinatesInterface, viewport: ViewportInterface, instanceId?: number): boolean
Called when the user starts dragging the target

Returns
Parameters
- position: MouseEventCoordinatesInterface
  
  Mouse position
- viewport: ViewportInterface
  
  The current viewport
- Optional instanceId: number
  
  The index of the instance if the event occurred on an InstancedMesh.
Returns boolean

`Optional` onHold

onHold(pos: MouseEventCoordinatesInterface, instanceId?: number): boolean
Called for click-and-hold and touch-and-hold

Returns
Return true to consume the event, false to pass it on
Parameters
- pos: MouseEventCoordinatesInterface
  
  Mouse position
- Optional instanceId: number
  
  The index of the instance if the event occurred on an InstancedMesh.d
Returns boolean

`Optional` onMouseMove

onMouseMove(pos: MouseEventCoordinatesInterface, viewport: ViewportInterface, instanceId?: number): void
Called when the mouse is moved
Parameters
- pos: MouseEventCoordinatesInterface
  
  Mouse position
- viewport: ViewportInterface
  
  The current viewport
- Optional instanceId: number
  
  The index of the instance if the event occurred on an InstancedMesh.
Returns void

`Optional` onMouseOut

onMouseOut(pos: MouseEventCoordinatesInterface, viewport: ViewportInterface, instanceId?: number): void
Called when the mouse pointer leaves the target
Parameters
- pos: MouseEventCoordinatesInterface
  
  Mouse position
- viewport: ViewportInterface
  
  The current viewport
- Optional instanceId: number
  
  The index of the instance if the event occurred on an InstancedMesh.
Returns void

`Optional` onMouseOver

onMouseOver(pos: MouseEventCoordinatesInterface, viewport: ViewportInterface, instanceId?: number): void
Called when the mouse is hovered on the target
Parameters
- pos: MouseEventCoordinatesInterface
  
  Mouse position
- viewport: ViewportInterface
  
  The current viewport
- Optional instanceId: number
  
  The index of the instance if the event occurred on an InstancedMesh.
Returns void

`Optional` onMouseWheel

onMouseWheel(pos: MouseEventCoordinatesInterface, delta: number, instanceId?: number): boolean
Called when the mouse wheel is turned

Returns
Parameters
- pos: MouseEventCoordinatesInterface
  
  Mouse position
- delta: number
  
  Mouse wheel delta
- Optional instanceId: number
  
  The index of the instance if the event occurred on an InstancedMesh.
Returns boolean

Generated using TypeDoc