Interface MouseEventReceiverInterface

Mouse and touch events

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

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

    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

    Returns boolean

    Return true to consume the event, false to pass it on

Optional onDrag

  • onDrag(position, viewport, instanceId?): void

  • Called during dragging

    Parameters

    Returns void

Optional onDragCancel

  • onDragCancel(instanceId?): 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, viewport, instanceId?): void

  • Called when the user releases the mouse button after dragging

    Parameters

    Returns void

Optional onDragStart

  • onDragStart(position, viewport, instanceId?): boolean

  • Called when the user starts dragging the target

    Parameters

    Returns boolean

Optional onHold

  • onHold(pos, instanceId?): boolean

  • Called for click-and-hold and touch-and-hold

    Parameters

    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

    Returns void

Optional onMouseOut

  • onMouseOut(pos, viewport, instanceId?): void

  • Called when the mouse pointer leaves the target

    Parameters

    Returns void

Optional onMouseOver

  • onMouseOver(pos, viewport, instanceId?): void

  • Called when the mouse is hovered on the target

    Parameters

    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

    • Optional instanceId: number

      The index of the instance if the event occurred on an InstancedMesh.

    Returns boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc