Pointer

class Pointer extends Bounds

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

Summary

Properties from Pointer

number	button = 0
number	clientX = 0
number	clientY = 0
number	deltaMode = 0
number	deltaX = 0
number	deltaY = 0
number	deltaZ = 0
PointerEvent \| TouchEvent \| MouseEvent	event
number	gameLocalX = 0
number	gameLocalY = 0
number	gameScreenX = 0
number	gameScreenY = 0
number	gameWorldX = 0
number	gameWorldY = 0
number	gameX = 0
number	gameY = 0
boolean	isNormalized = false
boolean	isPrimary = false
number	LEFT = 0
boolean	locked = false
number	MIDDLE = 1
number	movementX = 0
number	movementY = 0
number	pageX = 0
number	pageY = 0
number	pointerId
number	RIGHT = 2
string	type

Properties inherited from Bounds

number	bottom
Vector2d	center
number	centerX
number	centerY
number	height
number	left
number	right
number	top
number	width
number	x
number	y

Methods inherited from Bounds

	add(vertices: Array<Vector2d> \| Array<Point>, clear: boolean)
	addBounds(bounds: Bounds, clear: boolean)
	addFrame(x0: number, y0: number, x1: number, y1: number, m: Matrix2d)
	addPoint(point: Vector2d \| Point, m: Matrix2d)
	centerOn(x: number, y: number)
	clear() reset the bound
Bounds	clone()
boolean	contains(x: number \| Vector2d, y: number)
boolean	isFinite()
boolean	overlaps(bounds: Bounds \| Rect)
	setMinMax(minX: number, minY: number, maxX: number, maxY: number)
	shift(x: number \| Vector2d, y: number)
Polygon	toPolygon()
	translate(x: number \| Vector2d, y: number)
	update(vertices: Array<Vector2d> \| Array<Point>)

Public Properties

button pointer.js:83

button: number = 0

number

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

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

clientX pointer.js:123

clientX: number = 0

number

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

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

clientY pointer.js:133

clientY: number = 0

number

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

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

deltaMode pointer.js:163

deltaMode: number = 0

number

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

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

deltaX pointer.js:173

deltaX: number = 0

number

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

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

deltaY pointer.js:183

deltaY: number = 0

number

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

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

deltaZ pointer.js:193

deltaZ: number = 0

number

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

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

event pointer.js:60

event: PointerEvent | TouchEvent | MouseEvent

PointerEvent | TouchEvent | MouseEvent

the originating Event Object

See:

gameLocalX pointer.js:259

gameLocalX: number = 0

number

Event X coordinate relative to the holding container

gameLocalY pointer.js:268

gameLocalY: number = 0

number

Event Y coordinate relative to the holding container

gameScreenX pointer.js:223

gameScreenX: number = 0

number

Event X coordinate relative to the viewport

gameScreenY pointer.js:232

gameScreenY: number = 0

number

Event Y coordinate relative to the viewport

gameWorldX pointer.js:241

gameWorldX: number = 0

number

Event X coordinate relative to the map

gameWorldY pointer.js:250

gameWorldY: number = 0

number

Event Y coordinate relative to the map

gameX pointer.js:203

gameX: number = 0

number

Event normalized X coordinate within the game canvas itself

gameY pointer.js:213

gameY: number = 0

number

Event normalized Y coordinate within the game canvas itself

isNormalized pointer.js:287

isNormalized: boolean = false

boolean

true if not originally a pointer event

isPrimary pointer.js:93

isPrimary: boolean = false

boolean

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

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

LEFT pointer.js:33

LEFT: number = 0

number

constant for left button

locked pointer.js:296

locked: boolean = false

boolean

true if the pointer is currently locked

MIDDLE pointer.js:42

MIDDLE: number = 1

number

constant for middle button

movementX pointer.js:143

movementX: number = 0

number

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

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

movementY pointer.js:153

movementY: number = 0

number

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

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

pageX pointer.js:103

pageX: number = 0

number

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

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

pageY pointer.js:113

pageY: number = 0

number

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

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

pointerId pointer.js:277

pointerId: number

number

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

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

RIGHT pointer.js:51

RIGHT: number = 2

number

constant for right button

type pointer.js:72

type: string

string

a string containing the event's type.

See: https://developer.mozilla.org/en-US/docs/Web/API/Event/type