Class: InteractionManager

PIXI.interaction. InteractionManager

The interaction manager deals with mouse and touch events. Any DisplayObject can be interactive
if its interactive parameter is set to true
This manager also supports multitouch.

An instance of this class is automatically created by default, and can be found at renderer.plugins.interaction

new PIXI.interaction.InteractionManager(renderer, options)

Name Type Description
renderer PIXI.CanvasRenderer | PIXI.WebGLRenderer

A reference to the current renderer

options object optional

The options for the manager.

Name Type Default Description
autoPreventDefault boolean true optional

Should the manager automatically prevent default browser actions.

interactionFrequency number 10 optional

Frequency increases the interaction events will be checked.

Extends

  • EventEmitter

Members

autoPreventDefaultboolean

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

currentCursorStylestring

The css style of the cursor that is being used.

defaultCursorStylestring

Every update cursor will be reset to this value, if some element wont override it in
its hitTest.

Default Value:
  • 'inherit'

eventDataobject

An event data object to handle all the event tracking/dispatching

interactionFrequencynumber

Frequency in milliseconds that the mousemove, moveover & mouseout interaction events will be checked.

Default Value:
  • 10

interactiveDataPoolArray.<PIXI.interaction.InteractionData>

Tiny little interactiveData pool !

The mouse data

moveWhenInsideboolean

This property determines if mousemove and touchmove events are fired only when the cursor
is over the object.
Setting to true will make things work more in line with how the DOM verison works.
Setting to false can make things easier for things like dragging
It is currently set to false as this is how pixi used to work. This will be set to true in
future versions of pixi.

Default Value:
  • false

The pointer data

The renderer this interaction manager works for.

resolutionnumber

The current resolution / device pixel ratio.

Default Value:
  • 1

readonlysupportsPointerEventsboolean

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

readonlysupportsTouchEventsboolean

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

Methods

Destroys the interaction manager

mapPositionToPoint(point, x, y)

Maps x and y coords from a DOM object and maps them correctly to the pixi 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.Point

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

processInteractive(point, displayObject, func, hitTest, interactive){boolean}

This function is provides a neat way of crawling through the scene graph and running a
specified function on all interactive objects it finds. It will also take care of hit
testing the interactive objects and passes the hit across in the function.

Name Type Description
point PIXI.Point

the point that is tested for collision

displayObject PIXI.Container | PIXI.Sprite | PIXI.extras.TilingSprite

the displayObject
that will be hit test (recursively crawls its children)

func function optional

the function that will be called on each interactive object. The
displayObject and hit will be passed to the function

hitTest boolean optional

this indicates if the objects inside should be hit test against the point

interactive boolean optional

Whether the displayObject is interactive

Returns:
Type Description
boolean returns true if the displayObject hit the point

Updates the state of interactive objects.
Invoked by a throttled ticker update from PIXI.ticker.shared.

Name Type Description
deltaTime number

time delta since last tick

Events

Fired when a pointer device button (usually a mouse button) is pressed and released on
the display object.

Fired when a pointer device button (usually a mouse button) is pressed on the display
object.

Fired when a pointer device (usually a mouse) is moved while over the display object

Fired when a pointer device (usually a mouse) is moved off the display object

Fired when a pointer device (usually a mouse) is moved onto the display object

Fired when a pointer device button (usually a mouse button) is released over the display
object.

Fired when a pointer device button (usually a mouse button) is released outside the
display object that initially registered a
mousedown.

Fired when a pointer device button is pressed on the display object.

Fired when a pointer device is moved while over the display object

Fired when a pointer device is moved off the display object

Fired when a pointer device is moved onto the display object

Fired when a pointer device button is pressed and released on the display object.

Fired when a pointer device button is released over the display object.

Fired when a pointer device button is released outside the display object that initially
registered a pointerdown.

Fired when a pointer device secondary button (usually a mouse right-button) is pressed
and released on the display object.

Fired when a pointer device secondary button (usually a mouse right-button) is pressed
on the display object.

Fired when a pointer device secondary button (usually a mouse right-button) is released
over the display object.

Fired when a pointer device secondary button (usually a mouse right-button) is released
outside the display object that initially registered a
rightdown.

Fired when a touch point is placed and removed from the display object.

Fired when a touch point is removed from the display object.

Fired when a touch point is removed outside of the display object that initially
registered a touchstart.

Fired when a touch point is moved along the display object.

Fired when a touch point is placed on the display object.