PIXI

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.

new PIXI.interaction.InteractionManager(renderer, options)

interaction/InteractionManager.js, line 25
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

Methods

destroy()

interaction/InteractionManager.js, line 1540

Destroys the interaction manager

mapPositionToPoint(point, x, y)

interaction/InteractionManager.js, line 719

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}

interaction/InteractionManager.js, line 751

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 (recurcsivly 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

update(deltaTime)

interaction/InteractionManager.js, line 644

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

click

interaction/InteractionManager.js, line 330

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

mousedown

interaction/InteractionManager.js, line 298

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

mousemove

interaction/InteractionManager.js, line 364

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

mouseout

interaction/InteractionManager.js, line 378

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

mouseover

interaction/InteractionManager.js, line 371

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

mouseup

interaction/InteractionManager.js, line 314

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

mouseupoutside

interaction/InteractionManager.js, line 346

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

pointerdown

interaction/InteractionManager.js, line 385

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

pointermove

interaction/InteractionManager.js, line 414

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

pointerout

interaction/InteractionManager.js, line 428

Fired when a pointer device is moved off the display object

pointerover

interaction/InteractionManager.js, line 421

Fired when a pointer device is moved onto the display object

pointertap

interaction/InteractionManager.js, line 399

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

pointerup

interaction/InteractionManager.js, line 392

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

pointerupoutside

interaction/InteractionManager.js, line 406

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

rightclick

interaction/InteractionManager.js, line 338

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

rightdown

interaction/InteractionManager.js, line 306

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

rightup

interaction/InteractionManager.js, line 322

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

rightupoutside

interaction/InteractionManager.js, line 355

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

tap

interaction/InteractionManager.js, line 449

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

touchend

interaction/InteractionManager.js, line 442

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

touchendoutside

interaction/InteractionManager.js, line 456

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

touchmove

interaction/InteractionManager.js, line 464

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

touchstart

interaction/InteractionManager.js, line 435

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