Interface MouseEventReceiverInterface

Mouse and touch events

Hierarchy

MouseEventReceiverInterface

Index

Methods

Methods

Optional onClick

onClick(pos: MouseEventCoordinatesInterface, instanceId?: number): boolean

Called for mouse clicks and taps

Parameters
- pos: MouseEventCoordinatesInterface
  
  Mouse position
- Optional instanceId: 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: MouseEventCoordinatesInterface, instanceId?: number): boolean

Called for double clicks and double taps

Parameters
- pos: MouseEventCoordinatesInterface
  
  Mouse position
- Optional instanceId: 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: 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(instanceId?: number): void

Called when the user releases the mouse button after dragging

Parameters
- 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

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

Parameters
- pos: MouseEventCoordinatesInterface
  
  Mouse position
- Optional instanceId: 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: 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

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