PixiJS

Class: EventSystem

PIXI.EventSystem

The system for handling UI events.

new PIXI.EventSystem (renderer)

EventSystem.ts:201
Name Type Description
renderer PIXI.Renderer

Implements

Members

PIXI.EventSystem.defaultEventFeatures PIXI.EventSystemFeatures static

The event features that are enabled by the EventSystem This option only is available when using @pixi/events package (included in the pixi.js and pixi.js-legacy bundle), otherwise it will be ignored.

Since:
  • 7.2.0

PIXI.EventSystem.defaultEventMode PIXI.EventMode staticreadonly

The default interaction mode for all display objects.

Since:
  • 7.2.0
See:

autoPreventDefault boolean

Should default browser actions automatically be prevented. Does not apply to pointer events for backwards compatibility preventDefault on pointer events stops mouse events from firing Thus, for every pointer event, there will always be either a mouse of touch event alongside it.

Default Value:
  • true

cursorStyles Record<string, string | ((mode: string) => void) | CSSStyleDeclaration>

Dictionary of how different cursor modes are handled. Strings are handled as CSS cursor values, objects are handled as dictionaries of CSS values for domElement, and functions are called instead of changing the CSS. Default CSS cursor values are provided for 'default' and 'pointer' modes.

domElement HTMLElement

The DOM element to which the root event listeners are bound. This is automatically set to the renderer's view.

Default Value:
  • undefined

features PIXI.EventSystemFeatures readonly

The event features that are enabled by the EventSystem This option only is available when using @pixi/events package (included in the pixi.js and pixi.js-legacy bundle), otherwise it will be ignored.

Since:
  • 7.2.0
Example
 const app = new PIXI.Application()
 app.renderer.events.features.globalMove = false

 // to override all features use Object.assign
 Object.assign(app.renderer.events.features, {
  move: false,
  globalMove: false,
  click: false,
  wheel: false,
 })

pointer Readonly<PIXI.FederatedPointerEvent>

The global pointer event. Useful for getting the pointer position without listening to events.

Since:
  • 7.2.0

renderer PIXI.IRenderer

The renderer managing this PIXI.EventSystem.

resolution number

The resolution used to convert between the DOM client space into world space.

Default Value:
  • 1

rootBoundary PIXI.EventBoundary readonly

The PIXI.EventBoundary for the stage.

The rootTarget of this root boundary is automatically set to the last rendered object before any event processing is initiated. This means the main scene needs to be rendered atleast once before UI events will start propagating.

The root boundary should only be changed during initialization. Otherwise, any state held by the event boundary may be lost (like hovered & pressed DisplayObjects).

supportsPointerEvents readonly

Does the device support pointer events https://www.w3.org/Submission/pointer-events/

Default Value:
  • --

supportsTouchEvents readonly

Does the device support touch events https://www.w3.org/TR/touch-events/

Methods

destroy () void

EventSystem.ts:265

Destroys all event listeners and detaches the renderer.

mapPositionToPoint (point, x, y) void

EventSystem.ts:602

Maps x and y coords from a DOM object and maps them correctly to the PixiJS view. The resulting value is stored in the point. This takes into account the fact that the DOM element could be scaled and positioned anywhere on the screen.

Name Type Description
point PIXI.IPointData

the point that the result will be stored in
x number

the x coord of the position to map
y number

the y coord of the position to map

setCursor (mode) void

EventSystem.ts:272

Sets the current cursor mode, handling any callbacks or CSS style changes.

Name Type Description
mode string

cursor mode, a key from the cursorStyles dictionary

setTargetElement (element) void

EventSystem.ts:468

Sets the domElement and binds event listeners.

To deregister the current DOM element without setting a new one, pass null.

Name Type Description
element HTMLElement

The new DOM element.

normalizeWheelEvent (nativeEvent) PIXI.FederatedWheelEvent protected

EventSystem.ts:704

Normalizes the native WheelEvent.

The returned PIXI.FederatedWheelEvent is a shared instance. It will not persist across multiple native wheel events.

Name Type Description
nativeEvent WheelEvent

The native wheel event that occurred on the canvas.
Returns:
Type Description
PIXI.FederatedWheelEvent A federated wheel event.

onWheel (nativeEvent) void protected

EventSystem.ts:455

Passive handler for wheel events on this.domElement.

Name Type Description
nativeEvent WheelEvent

The native wheel event.