Interface MouseEventReceiverInterface

Mouse and touch events

interface MouseEventReceiverInterface {
    onClick?(pos: MouseEventCoordinatesInterface, instanceId?: number): boolean;
    onDoubleClick?(pos: MouseEventCoordinatesInterface, instanceId?: number): boolean;
    onDrag?(position: MouseEventCoordinatesInterface, viewport: ViewportInterface, instanceId?: number): void;
    onDragCancel?(instanceId?: number): void;
    onDragEnd?(position: MouseEventCoordinatesInterface, viewport: ViewportInterface, instanceId?: number): void;
    onDragStart?(position: MouseEventCoordinatesInterface, viewport: ViewportInterface, instanceId?: number): boolean;
    onHold?(pos: MouseEventCoordinatesInterface, instanceId?: number): boolean;
    onMouseMove?(pos: MouseEventCoordinatesInterface, viewport: ViewportInterface, instanceId?: number): void;
    onMouseOut?(pos: MouseEventCoordinatesInterface, viewport: ViewportInterface, instanceId?: number): void;
    onMouseOver?(pos: MouseEventCoordinatesInterface, viewport: ViewportInterface, instanceId?: number): void;
    onMouseWheel?(pos: MouseEventCoordinatesInterface, delta: number, instanceId?: number): boolean;
}

Index

Methods

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

Methods

`Optional`onClick

onClick(pos, instanceId?): boolean
Called for mouse clicks and taps
Parameters
- pos: MouseEventCoordinatesInterface
  Mouse position
- OptionalinstanceId: number
  The index of the instance if the event occurred on an InstancedMesh.
Returns boolean
Return true to consume the event, false to pass it on

`Optional`onDoubleClick

onDoubleClick(pos, instanceId?): boolean
Called for double clicks and double taps
Parameters
- pos: MouseEventCoordinatesInterface
  Mouse position
- OptionalinstanceId: number
  The index of the instance if the event occurred on an InstancedMesh.
Returns boolean
Return true to consume the event, false to pass it on

`Optional`onDrag

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

`Optional`onDragCancel

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

`Optional`onDragEnd

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

`Optional`onDragStart

onDragStart(position, viewport, instanceId?): boolean
Called when the user starts dragging the target
Parameters
- position: MouseEventCoordinatesInterface
  Mouse position
- viewport: ViewportInterface
  The current viewport
- OptionalinstanceId: number
  The index of the instance if the event occurred on an InstancedMesh.
Returns boolean

`Optional`onHold

onHold(pos, instanceId?): boolean
Called for click-and-hold and touch-and-hold
Parameters
- pos: MouseEventCoordinatesInterface
  Mouse position
- OptionalinstanceId: number
  The index of the instance if the event occurred on an InstancedMesh.d
Returns boolean
Return true to consume the event, false to pass it on

`Optional`onMouseMove

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

`Optional`onMouseOut

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

`Optional`onMouseOver

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

`Optional`onMouseWheel

onMouseWheel(pos, delta, instanceId?): boolean
Called when the mouse wheel is turned
Parameters
- pos: MouseEventCoordinatesInterface
  Mouse position
- delta: number
  Mouse wheel delta
- OptionalinstanceId: number
  The index of the instance if the event occurred on an InstancedMesh.
Returns boolean