Class Pointer

a pointer object, representing a single finger on a touch enabled device.

Hierarchy (view full)

Properties

LEFT MIDDLE RIGHT _center bind button clientX clientY deltaMode deltaX deltaY deltaZ event gameLocalX gameLocalY gameScreenX gameScreenY gameWorldX gameWorldY gameX gameY isNormalized isPrimary locked max min movementX movementY pageX pageY pointerId type

Accessors

bottom center centerX centerY height left right top width x y

Methods

add addBounds addFrame addPoint centerOn clear clone contains isFinite overlaps setMinMax shift toPolygon translate update

Properties

LEFT

LEFT: number

constant for left button

Name

LEFT

Memberof

Pointer

MIDDLE

MIDDLE: number

constant for middle button

Name

MIDDLE

Memberof

Pointer

RIGHT

RIGHT: number

constant for right button

Name

RIGHT

Memberof

Pointer

_center

_center: Vector2d

bind

bind: number[]

button

button: number

the button property indicates which button was pressed on the mouse to trigger the event.

Name

button

See

https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/button

Memberof

Pointer

clientX

clientX: number

the horizontal coordinate within the application's client area at which the event occurred

Name

clientX

See

https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/clientX

Memberof

Pointer

clientY

clientY: number

the vertical coordinate within the application's client area at which the event occurred

Name

clientY

See

https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/clientY

Memberof

Pointer

deltaMode

deltaMode: number

an unsigned long representing the unit of the delta values scroll amount

Name

deltaMode

See

https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/deltaMode

Memberof

Pointer

deltaX

deltaX: number

a double representing the horizontal scroll amount in the Wheel Event deltaMode unit.

Name

deltaX

See

https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/deltaX

Memberof

Pointer

deltaY

deltaY: number

a double representing the vertical scroll amount in the Wheel Event deltaMode unit.

Name

deltaY

See

https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/deltaY

Memberof

Pointer

deltaZ

deltaZ: number

a double representing the scroll amount in the z-axis, in the Wheel Event deltaMode unit.

Name

deltaZ

See

https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/deltaZ

Memberof

Pointer

event

event: PointerEvent | MouseEvent | TouchEvent

the originating Event Object

Name

event

See

Memberof

Pointer

gameLocalX

gameLocalX: number

Event X coordinate relative to the holding container

Name

gameLocalX

Memberof

Pointer

gameLocalY

gameLocalY: number

Event Y coordinate relative to the holding container

Name

gameLocalY

Memberof

Pointer

gameScreenX

gameScreenX: number

Event X coordinate relative to the viewport

Name

gameScreenX

Memberof

Pointer

gameScreenY

gameScreenY: number

Event Y coordinate relative to the viewport

Name

gameScreenY

Memberof

Pointer

gameWorldX

gameWorldX: number

Event X coordinate relative to the map

Name

gameWorldX

Memberof

Pointer

gameWorldY

gameWorldY: number

Event Y coordinate relative to the map

Name

gameWorldY

Memberof

Pointer

gameX

gameX: number

Event normalized X coordinate within the game canvas itself

Name

gameX

Memberof

Pointer

gameY

gameY: number

Event normalized Y coordinate within the game canvas itself

Name

gameY

Memberof

Pointer

isNormalized

isNormalized: boolean

true if not originally a pointer event

Name

isNormalized

Memberof

Pointer

isPrimary

isPrimary: boolean

indicates whether or not the pointer device that created the event is the primary pointer.

Name

isPrimary

See

https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent/isPrimary

Memberof

Pointer

locked

locked: boolean

true if the pointer is currently locked

Name

locked

Memberof

Pointer

max

max: undefined | {
    x: number;
    y: number;
}

min

min: undefined | {
    x: number;
    y: number;
}

movementX

movementX: number

the difference in the X coordinate of the pointer since the previous move event

Name

movementX

See

https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/movementX

Memberof

Pointer

movementY

movementY: number

the difference in the Y coordinate of the pointer since the previous move event

Name

movementY

See

https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/movementY

Memberof

Pointer

pageX

pageX: number

the horizontal coordinate at which the event occurred, relative to the left edge of the entire document.

Name

pageX

See

https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/pageX

Memberof

Pointer

pageY

pageY: number

the vertical coordinate at which the event occurred, relative to the left edge of the entire document.

Name

pageY

See

https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/pageY

Memberof

Pointer

pointerId

pointerId: number

The unique identifier of the contact for a touch, mouse or pen

Name

pointerId

Memberof

Pointer

See

https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent/pointerId

type

type: string

the object type (used internally)

Default

"Bounds"

Accessors

bottom

  • get bottom(): number

  • bottom coordinate of the bound

    Returns number

center

centerX

  • get centerX(): number

  • center position of the bound on the x axis

    Returns number

centerY

  • get centerY(): number

  • center position of the bound on the y axis

    Returns number

height

left

right

  • get right(): number

  • right coordinate of the bound

    Returns number

top

width

x

y

Methods

add

  • add(vertices, clear?): void

  • add the given vertices to the bounds definition.

    Parameters

    • vertices: Vector2d[] | Point[]

      an array of Vector2d or Point

    • Optionalclear: boolean = false

      either to reset the bounds before adding the new vertices

    Returns void

addBounds

  • addBounds(bounds, clear?): void

  • add the given bounds to the bounds definition.

    Parameters

    • bounds: Bounds
    • Optionalclear: boolean = false

      either to reset the bounds before adding the new vertices

    Returns void

addFrame

  • addFrame(x0, y0, x1, y1, m?): void

  • add the given quad coordinates to this bound definition, multiplied by the given matrix

    Parameters

    • x0: number

      left X coordinates of the quad

    • y0: number

      top Y coordinates of the quad

    • x1: number

      right X coordinates of the quad

    • y1: number

      bottom y coordinates of the quad

    • Optionalm: any

      an optional transform to apply to the given frame coordinates

    Returns void

addPoint

  • addPoint(point, m?): void

  • add the given point to the bounds definition.

    Parameters

    • point: Vector2d | Point

      the vector or point to be added to the bounds

    • Optionalm: any

      an optional transform to apply to the given point (if the given point is a Vector2d)

    Returns void

centerOn

  • centerOn(x, y): Pointer

  • center the bounds position around the given coordinates

    Parameters

    • x: number

      the x coordinate around which to center this bounds

    • y: number

      the y coordinate around which to center this bounds

    Returns Pointer

clear

clone

contains

  • contains(...args): boolean

  • Returns true if the bounds contains the given point.

    Parameters

    • Rest...args: any

    Returns boolean

    True if the bounds contain the point, otherwise false

    Example

    if (bounds.contains(10, 10)) {
      // do something
    }
    // or
    if (bounds.contains(myVector2d)) {
      // do something
    }

isFinite

  • isFinite(): boolean

  • determines whether all coordinates of this bounds are finite numbers.

    Returns boolean

    false if all coordinates are positive or negative Infinity or NaN; otherwise, true.

overlaps

setMinMax

  • setMinMax(minX, minY, maxX, maxY): void

  • sets the bounds to the given min and max value

    Parameters

    • minX: number
    • minY: number
    • maxX: number
    • maxY: number

    Returns void

shift

  • shift(...args): void

  • Shifts the bounds to the given x, y position.

    Parameters

    • Rest...args: any

    Returns void

    Example

    bounds.shift(10, 10);
    // or
    bounds.shift(myVector2d);

toPolygon

translate

  • translate(...args): void

  • Translates the bounds by the given point

    Parameters

    • Rest...args: any

    Returns void

    Example

    bounds.translate(10, 10);
    // or
    bounds.translate(myVector2d);

update

Settings

Member Visibility

On This Page

LEFTMIDDLERIGHT_centerbindbuttonclientXclientYdeltaModedeltaXdeltaYdeltaZeventgameLocalXgameLocalYgameScreenXgameScreenYgameWorldXgameWorldYgameXgameYisNormalizedisPrimarylockedmaxminmovementXmovementYpageXpageYpointerIdtypebottomcentercenterXcenterYheightleftrighttopwidthxyaddaddBoundsaddFrameaddPointcenterOnclearclonecontainsisFiniteoverlapssetMinMaxshifttoPolygontranslateupdate