API
API|
@babylonjs/core|
IPointerEvent

Interface IPointerEvent

Native friendly interface for PointerEvent Object

interface IPointerEvent {
    altKey: boolean;
    button: number;
    buttons: number;
    clientX: number;
    clientY: number;
    ctrlKey: boolean;
    currentTarget?: any;
    detail?: number;
    inputIndex:
        | LeftClick
        | MiddleClick
        | RightClick
        | BrowserBack
        | BrowserForward
        | Move;
    metaKey: boolean;
    movementX: number;
    movementY: number;
    mozMovementX?: number;
    mozMovementY?: number;
    msMovementX?: number;
    msMovementY?: number;
    offsetX: number;
    offsetY: number;
    pageX: number;
    pageY: number;
    pointerId: number;
    pointerType: string;
    preventDefault: () => void;
    shiftKey: boolean;
    srcElement?: any;
    target: any;
    type: string;
    webkitMovementX?: number;
    webkitMovementY?: number;
    x: number;
    y: number;
}

Hierarchy (View Summary)

Index
altKey button buttons clientX clientY ctrlKey currentTarget? detail? inputIndex metaKey movementX movementY mozMovementX? mozMovementY? msMovementX? msMovementY? offsetX offsetY pageX pageY pointerId pointerType preventDefault shiftKey srcElement? target type webkitMovementX? webkitMovementY? x y
altKey: boolean

Status of Alt key being pressed

button: number

Value of single mouse button pressed

buttons: number

Value of all mouse buttons pressed

clientX: number

Current X coordinate

clientY: number

Current Y coordinate

ctrlKey: boolean

Status of Ctrl key being pressed

currentTarget?: any

Current target for an event

detail?: number

Provides current click count

inputIndex:
    | LeftClick
    | MiddleClick
    | RightClick
    | BrowserBack
    | BrowserForward
    | Move

Subset of possible PointerInput values for events, excluding ones that CANNOT be in events organically and mouse wheel values

metaKey: boolean

Status of Meta key (eg. Windows key) being pressed

movementX: number

Delta of movement on X axis

movementY: number

Delta of movement on Y axis

mozMovementX?: number

Delta of movement on X axis

Use 'movementX' instead

mozMovementY?: number

Delta of movement on Y axis

Use 'movementY' instead

msMovementX?: number

Delta of movement on X axis

Use 'movementX' instead

msMovementY?: number

Delta of movement on Y axis

Use 'movementY' instead

offsetX: number

Current coordinate of X within container

offsetY: number

Current coordinate of Y within container

pageX: number

Horizontal coordinate of event

pageY: number

Vertical coordinate of event

pointerId: number

Pointer Event ID

pointerType: string

Type of pointer

preventDefault: () => void

Tells user agent what to do when not explicitly handled

shiftKey: boolean

Status of Shift key being pressed

srcElement?: any

Alias for target

Use target instead

target: any

Reference to object where object was dispatched

type: string

Type of event

webkitMovementX?: number

Delta of movement on X axis

Use 'movementX' instead

webkitMovementY?: number

Delta of movement on Y axis

Use 'movementY' instead

x: number

Alias of clientX

y: number

Alias of clientY