Class Pointer

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

Hierarchy (view full)

Bounds
- Pointer

Properties

LEFT

LEFT: number

constant for left button

MIDDLE

MIDDLE: number

constant for middle button

RIGHT

RIGHT: number

constant for right button

_center

_center: Vector2d

bind

bind: number[]

button

button: 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

clientX: 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

clientY: 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

deltaMode: 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

deltaX: 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

deltaY: 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

deltaZ: 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

event: PointerEvent | MouseEvent | TouchEvent

the originating Event Object

See

gameLocalX

gameLocalX: number

Event X coordinate relative to the holding container

gameLocalY

gameLocalY: number

Event Y coordinate relative to the holding container

gameScreenX

gameScreenX: number

Event X coordinate relative to the viewport

gameScreenY

gameScreenY: number

Event Y coordinate relative to the viewport

gameWorldX

gameWorldX: number

Event X coordinate relative to the map

gameWorldY

gameWorldY: number

Event Y coordinate relative to the map

gameX

gameX: number

Event normalized X coordinate within the game canvas itself

gameY

gameY: number

Event normalized Y coordinate within the game canvas itself

isNormalized

isNormalized: boolean

true if not originally a pointer event

isPrimary

isPrimary: 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

locked

locked: boolean

true if the pointer is currently locked

max

max: XYPoint

min

min: XYPoint

movementX

movementX: 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

movementY: 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

pageX: 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

pageY: 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

pointerId: 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

type

type: "Bounds"

Accessors

bottom

get bottom(): number
Gets the bottom coordinate of the bounds.

Returns number
The bottom coordinate.
Inherited from Bounds.bottom
- Defined in packages/melonjs/src/physics/bounds.ts:150

center

get center(): Vector2d
Gets the center position of the bounds.

Returns Vector2d
The center position as a Vector2d.
Inherited from Bounds.center
- Defined in packages/melonjs/src/physics/bounds.ts:174

centerX

get centerX(): number
Gets the center position of the bounds on the x axis.

Returns number
The center x coordinate.
Inherited from Bounds.centerX
- Defined in packages/melonjs/src/physics/bounds.ts:158

centerY

get centerY(): number
Gets the center position of the bounds on the y axis.

Returns number
The center y coordinate.
Inherited from Bounds.centerY
- Defined in packages/melonjs/src/physics/bounds.ts:166

height

get height(): number
Gets the height of the bounds.

Returns number
The height.
Inherited from Bounds.height
- Defined in packages/melonjs/src/physics/bounds.ts:110
set height(value): void
Sets the height of the bounds.
Parameters
- value: number
  The new height.
Returns void
Inherited from Bounds.height
- Defined in packages/melonjs/src/physics/bounds.ts:118

left

get left(): number
Gets the left coordinate of the bounds.

Returns number
The left coordinate.
Inherited from Bounds.left
- Defined in packages/melonjs/src/physics/bounds.ts:126

right

get right(): number
Gets the right coordinate of the bounds.

Returns number
The right coordinate.
Inherited from Bounds.right
- Defined in packages/melonjs/src/physics/bounds.ts:134

top

get top(): number
Gets the top coordinate of the bounds.

Returns number
The top coordinate.
Inherited from Bounds.top
- Defined in packages/melonjs/src/physics/bounds.ts:142

width

get width(): number
Gets the width of the bounds.

Returns number
The width.
Inherited from Bounds.width
- Defined in packages/melonjs/src/physics/bounds.ts:94
set width(value): void
Sets the width of the bounds.
Parameters
- value: number
  The new width.
Returns void
Inherited from Bounds.width
- Defined in packages/melonjs/src/physics/bounds.ts:102

x

get x(): number
Gets the x position of the bounds.

Returns number
The x position.
Inherited from Bounds.x
- Defined in packages/melonjs/src/physics/bounds.ts:57
set x(value): void
Sets the x position of the bounds.
Parameters
- value: number
  The new x position.
Returns void
Inherited from Bounds.x
- Defined in packages/melonjs/src/physics/bounds.ts:65

y

get y(): number
Gets the y position of the bounds.

Returns number
The y position.
Inherited from Bounds.y
- Defined in packages/melonjs/src/physics/bounds.ts:75
set y(value): void
Sets the y position of the bounds.
Parameters
- value: number
  The new y position.
Returns void
Inherited from Bounds.y
- Defined in packages/melonjs/src/physics/bounds.ts:83

Methods

add

add(vertices, clear?): void
Adds the given vertices to the bounds definition.
Parameters
- vertices: Vector2d[] | Point[] | XYPoint[]
  An array of Vector2d or Point to add to the bounds.
- Optionalclear: boolean = false
  Whether to reset the bounds before adding the new vertices. Defaults to false.
Returns void
Inherited from Bounds.add
- Defined in packages/melonjs/src/physics/bounds.ts:202

addBounds

addBounds(bounds, clear?): void
Adds the given bounds to the bounds definition.
Parameters
- bounds: Bounds
  The bounds to add.
- Optionalclear: boolean = false
  Whether to reset the bounds before adding the new bounds.
Returns void
Inherited from Bounds.addBounds
- Defined in packages/melonjs/src/physics/bounds.ts:227

addFrame

addFrame(x0, y0, x1, y1, m?): void
Adds the given quad coordinates to this bounds definition, multiplied by the given matrix.
Parameters
- x0: number
  The left x coordinate of the quad.
- y0: number
  The top y coordinate of the quad.
- x1: number
  The right x coordinate of the quad.
- y1: number
  The bottom y coordinate of the quad.
- Optionalm: Matrix2d
  An optional transform to apply to the given coordinates.
Returns void
Inherited from Bounds.addFrame
- Defined in packages/melonjs/src/physics/bounds.ts:270

addPoint

addPoint(point, m?): void
Adds the given point to the bounds definition.
Parameters
- point: Vector2d | Point
  The point to add to the bounds.
- Optionalm: Matrix2d
  An optional transform to apply to the given point.
Returns void
Inherited from Bounds.addPoint
- Defined in packages/melonjs/src/physics/bounds.ts:254

centerOn

centerOn(x, y): Pointer
Centers the bounds position around the given coordinates.
Parameters
- x: number
  The x coordinate to center around.
- y: number
  The y coordinate to center around.
Returns Pointer
The current Bounds instance for method chaining.
Inherited from Bounds.centerOn
- Defined in packages/melonjs/src/physics/bounds.ts:184

clear

clear(): void
Resets the bounds to its initial state.

Returns void
Inherited from Bounds.clear
- Defined in packages/melonjs/src/physics/bounds.ts:34

clone

clone(): Bounds
Creates a clone of this bounds.

Returns Bounds
A new Bounds object that is a copy of this bounds.
Inherited from Bounds.clone
- Defined in packages/melonjs/src/physics/bounds.ts:403

contains

contains(x, y?): boolean
Returns true if the bounds contain the given point or vector.
Parameters
- x: number
- Optionaly: number
  The y coordinate if the first parameter is a number.
Returns boolean
True if the bounds contain the point or vector, otherwise false.
Inherited from Bounds.contains
- Defined in packages/melonjs/src/physics/bounds.ts:293
contains(vector): boolean
Parameters
- vector: Vector2d | Bounds
Returns boolean
Inherited from Bounds.contains
- Defined in packages/melonjs/src/physics/bounds.ts:294

isFinite

isFinite(): boolean
Determines whether all coordinates of this bounds are finite numbers.

Returns boolean
False if any coordinates are positive or negative Infinity or NaN; otherwise, true.
Inherited from Bounds.isFinite
- Defined in packages/melonjs/src/physics/bounds.ts:339

overlaps

overlaps(bounds): boolean
Returns true if the two bounds intersect.
Parameters
- bounds: Bounds
  The bounds to check for intersection.
Returns boolean
True if the bounds overlap, otherwise false.
Inherited from Bounds.overlaps
- Defined in packages/melonjs/src/physics/bounds.ts:326

setMinMax

setMinMax(minX, minY, maxX, maxY): void
Sets the bounds to the given minimum and maximum values.
Parameters
- minX: number
  The minimum x value.
- minY: number
  The minimum y value.
- maxX: number
  The maximum x value.
- maxY: number
  The maximum y value.
Returns void
Inherited from Bounds.setMinMax
- Defined in packages/melonjs/src/physics/bounds.ts:45

shift

shift(x, y?): void
Shifts the bounds to the given x, y position or vector.
Parameters
- x: number
- Optionaly: number
  The y coordinate if the first parameter is a number.
Returns void
Inherited from Bounds.shift
- Defined in packages/melonjs/src/physics/bounds.ts:376
shift(vector): void
Parameters
- vector: Vector2d
Returns void
Inherited from Bounds.shift
- Defined in packages/melonjs/src/physics/bounds.ts:377

toPolygon

toPolygon(): Polygon
Returns a polygon whose edges are the same as this bounds.

Returns Polygon
A new Polygon that represents this bounds.
Inherited from Bounds.toPolygon
- Defined in packages/melonjs/src/physics/bounds.ts:413

translate

translate(x, y?): void
Translates the bounds by the given point or vector.
Parameters
- x: number
- Optionaly: number
  The y coordinate if the first parameter is a number.
Returns void
Inherited from Bounds.translate
- Defined in packages/melonjs/src/physics/bounds.ts:353
translate(vector): void
Parameters
- vector: Vector2d
Returns void
Inherited from Bounds.translate
- Defined in packages/melonjs/src/physics/bounds.ts:354

update

update(vertices): void
Updates the bounds using the given vertices.
Parameters
- vertices: Vector2d[] | Point[] | XYPoint[]
  An array of Vector2d or Point to update the bounds.
Returns void
Inherited from Bounds.update
- Defined in packages/melonjs/src/physics/bounds.ts:193

Class Pointer

Hierarchy (view full)

Index

Properties

Accessors

Methods

Properties

LEFT

MIDDLE

RIGHT

_center

bind

button

See

clientX

See

clientY

See

deltaMode

See

deltaX

See

deltaY

See

deltaZ

See

event

See

gameLocalX

gameLocalY

gameScreenX

gameScreenY

gameWorldX

gameWorldY

gameX

gameY

isNormalized

isPrimary

See

locked

max

min

movementX

See

movementY

See

pageX

See

pageY

See

pointerId

See

type

Accessors

bottom

Returns number

center

Returns Vector2d

centerX

Returns number

centerY

Returns number

height

Returns number

Parameters

Returns void

left

Returns number

right

Returns number

top

Returns number

width

Returns number

Parameters

Returns void

x

Returns number

Parameters

Returns void