Class Pointer
Hierarchy (View Summary)
- Bounds
- Pointer
Index
Properties
Accessors
Methods
Properties
_
bind
button
the button property indicates which button was pressed on the mouse to trigger the event.
client
the horizontal coordinate within the application's client area at which the event occurred
client
the vertical coordinate within the application's client area at which the event occurred
delta
an unsigned long representing the unit of the delta values scroll amount
delta
a double representing the horizontal scroll amount in the Wheel Event deltaMode unit.
delta
a double representing the vertical scroll amount in the Wheel Event deltaMode unit.
delta
a double representing the scroll amount in the z-axis, in the Wheel Event deltaMode unit.
event
the originating Event Object
game
Event X coordinate relative to the holding container
game
Event Y coordinate relative to the holding container
game
Event X coordinate relative to the viewport
game
Event Y coordinate relative to the viewport
game
Event X coordinate relative to the map
game
Event Y coordinate relative to the map
game
Event normalized X coordinate within the game canvas itself
game
Event normalized Y coordinate within the game canvas itself
is
true if not originally a pointer event
is
indicates whether or not the pointer device that created the event is the primary pointer.
LEFT
constant for left button
locked
true if the pointer is currently locked
max
MIDDLE
constant for middle button
min
movement
the difference in the X coordinate of the pointer since the previous move event
movement
the difference in the Y coordinate of the pointer since the previous move event
page
the horizontal coordinate at which the event occurred, relative to the left edge of the entire document.
page
the vertical coordinate at which the event occurred, relative to the left edge of the entire document.
pointer
The unique identifier of the contact for a touch, mouse or pen
RIGHT
constant for right button
type
a string containing the event's type.
Accessors
bottom
- get bottom(): number
Gets the bottom coordinate of the bounds.
Returns number
The bottom coordinate.
center
center
- get centerX(): number
Gets the center position of the bounds on the x axis.
Returns number
The center x coordinate.
center
- get centerY(): number
Gets the center position of the bounds on the y axis.
Returns number
The center y coordinate.
height
- get height(): number
Gets the height of the bounds.
Returns number
The height.
- set height(value: number): void
Sets the height of the bounds.
Parameters
- value: number
The new height.
Returns void
- value: number
left
- get left(): number
Gets the left coordinate of the bounds.
Returns number
The left coordinate.
right
- get right(): number
Gets the right coordinate of the bounds.
Returns number
The right coordinate.
top
- get top(): number
Gets the top coordinate of the bounds.
Returns number
The top coordinate.
width
- get width(): number
Gets the width of the bounds.
Returns number
The width.
- set width(value: number): void
Sets the width of the bounds.
Parameters
- value: number
The new width.
Returns void
- value: number
x
- get x(): number
Gets the x position of the bounds.
Returns number
The x position.
- set x(value: number): void
Sets the x position of the bounds.
Parameters
- value: number
The new x position.
Returns void
- value: number
y
- get y(): number
Gets the y position of the bounds.
Returns number
The y position.
- set y(value: number): void
Sets the y position of the bounds.
Parameters
- value: number
The new y position.
Returns void
- value: number
Methods
add
add
Adds the given bounds to the bounds definition.
Parameters
- bounds: Bounds
The bounds to add.
Optionalclear: boolean = falseWhether to reset the bounds before adding the new bounds.
Returns void
- bounds: Bounds
add
Adds the given quad coordinates to this bounds definition, multiplied by the given matrix.
Parameters
Returns void
add
center
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.
- x: number
clear
Resets the bounds to its initial state.
Returns void
clone
contains
Returns true if the bounds contain the given point or vector.
Parameters
- x: number
Optionaly: numberThe y coordinate if the first parameter is a number.
Returns boolean
True if the bounds contain the point or vector, otherwise false.
is
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.
overlaps
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.
- bounds: Bounds
set
- setEvent(
event: Event,
pageX?: number,
pageY?: number,
clientX?: number,
clientY?: number,
pointerId?: number,
): voidinitialize the Pointer object using the given Event Object
Parameters
- event: Event
the original Event object
- pageX: number = 0
the horizontal coordinate at which the event occurred, relative to the left edge of the entire document
- pageY: number = 0
the vertical coordinate at which the event occurred, relative to the left edge of the entire document
- clientX: number = 0
the horizontal coordinate within the application's client area at which the event occurred
- clientY: number = 0
the vertical coordinate within the application's client area at which the event occurred
- pointerId: number = 1
the Pointer, Touch or Mouse event Id (1)
Returns void
- event: Event
set
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
- minX: number
shift
Shifts the bounds to the given x, y position or vector.
Parameters
- x: number
Optionaly: numberThe y coordinate if the first parameter is a number.
Returns void
to
Returns a polygon whose edges are the same as this bounds.
Returns Polygon
A new Polygon that represents this bounds.
translate
Translates the bounds by the given point or vector.
Parameters
- x: number
Optionaly: numberThe y coordinate if the first parameter is a number.
Returns void
a pointer object, representing a single finger on a touch enabled device.