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;
}

Methods

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

Methods

OptionalonClick

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

  • Called for mouse clicks and taps

    Parameters

    Returns boolean

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

OptionalonDoubleClick

  • onDoubleClick(pos: MouseEventCoordinatesInterface, instanceId?: number): boolean

  • Called for double clicks and double taps

    Parameters

    Returns boolean

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

OptionalonDrag

OptionalonDragCancel

  • onDragCancel(instanceId?: number): 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

OptionalonDragEnd

OptionalonDragStart

OptionalonHold

  • onHold(pos: MouseEventCoordinatesInterface, instanceId?: number): boolean

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

    Parameters

    Returns boolean

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

OptionalonMouseMove

OptionalonMouseOut

OptionalonMouseOver

OptionalonMouseWheel

  • 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

    • OptionalinstanceId: number

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

    Returns boolean

Settings

Member Visibility

On This Page

Methods