PIXI.FederatedPointerEvent

class FederatedPointerEvent extends PIXI.FederatedMouseEvent implements PointerEvent

A PIXI.FederatedEvent for pointer events.

Constructor

new PIXI.FederatedPointerEvent() → {}

Summary

Properties from FederatedPointerEvent

number	detail This is the number of clicks that occurs in 200ms/click of each other.
number	height = 0
boolean	isPrimary = false
number	pointerId
string	pointerType
number	pressure
number	tangentialPressure
number	tiltX
number	tiltY
number	twist
number	width = 0

Properties inherited from FederatedMouseEvent

boolean	altKey Whether the "alt" key was pressed when this mouse event occurred.
number	button The specific button that was pressed in this mouse event.
number	buttons The button depressed when this event occurred.
PIXI.Point	client The coordinates of the mouse event relative to the canvas.
number	clientX
number	clientY
boolean	ctrlKey Whether the "control" key was pressed when this mouse event occurred.
PIXI.Point	global The pointer coordinates in world space.
number	globalX
number	globalY
boolean	metaKey Whether the "meta" key was pressed when this mouse event occurred.
PIXI.Point	movement The movement in this pointer relative to the last `mousemove` event.
number	movementX
number	movementY
PIXI.Point	offset
number	offsetX
number	offsetY
EventTarget	relatedTarget This is currently not implemented in the Federated Events API.
PIXI.Point	screen
number	screenX
number	screenY
boolean	shiftKey Whether the "shift" key was pressed when this mouse event occurred.
number	x
number	y

Properties inherited from FederatedEvent

boolean	bubbles = true Flags whether this event bubbles. This will take effect only if it is set before propagation.
boolean	cancelable = false
boolean	cancelBubble = true
boolean	composed = false
PIXI.FederatedEventTarget	currentTarget The listeners of the event target that are being notified.
this	data
boolean	defaultPrevented = false Flags whether the default response of the user agent was prevent through this event.
	eventPhase = FederatedEvent.NONE
boolean	isTrusted Flags whether this is a user-trusted event
PIXI.Point	layer The coordinates of the evnet relative to the nearest DOM layer. This is a non-standard property.
number	layerX
number	layerY
PIXI.EventBoundary	manager The EventBoundary that manages this event. Null for root events.
N	nativeEvent The native event that caused the foremost original event.
PIXI.FederatedEvent<N>	originalEvent The original event that caused this event, if any.
PIXI.Point	page The coordinates of the event relative to the DOM document. This is a non-standard property.
number	pageX
number	pageY
PIXI.FederatedEventTarget[]	path The composed path of the event's propagation. The `target` is at the end.
boolean	propagationImmediatelyStopped = false Flags whether propagation was immediately stopped.
boolean	propagationStopped = false Flags whether propagation was stopped.
boolean	returnValue
EventTarget	srcElement
PIXI.FederatedEventTarget	target The event target that this will be dispatched to.
number	timeStamp The timestamp of when the event was created.
string	type The type of event, e.g. `"mouseup"`.
WindowProxy	view The global Window object.
number	which

Methods inherited from FederatedMouseEvent

boolean

getModifierState(key: string)

void

initMouseEvent(_typeArg: string, _canBubbleArg: boolean, _cancelableArg: boolean, _viewArg: Window, _detailArg: number, _screenXArg: number, _screenYArg: number, _clientXArg: number, _clientYArg: number, _ctrlKeyArg: boolean, _altKeyArg: boolean, _shiftKeyArg: boolean, _metaKeyArg: boolean, _buttonArg: number, _relatedTargetArg: EventTarget)

Methods inherited from FederatedEvent

PIXI.FederatedEventTarget[]	composedPath() The propagation path for this event. Alias for EventBoundary.propagationPath.
void	initEvent(_type: string, _bubbles: boolean, _cancelable: boolean)
void	preventDefault() Prevent default behavior of PixiJS and the user agent.
void	stopImmediatePropagation()
void	stopPropagation()