API Docs for: 2.0.0
Show:

InteractionManager Class

Defined in: src/pixi/InteractionManager.js:5
Module: PIXI

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.

Constructor

InteractionManager

(
  • stage
)

Defined in src/pixi/InteractionManager.js:5

Parameters:

  • stage Stage

    The stage to handle interactions

Methods

collectInteractiveSprite

(
  • displayObject
  • iParent
)
private

Defined in src/pixi/InteractionManager.js:110

Collects an interactive sprite recursively to have their interactions managed

Parameters:

hitTest

(
  • item
  • interactionData
)
private

Defined in src/pixi/InteractionManager.js:518

Tests if the current mouse coordinates hit a sprite

Parameters:

  • item DisplayObject

    The displayObject to test for a hit

  • interactionData InteractionData

    The interactionData object to update in the case there is a hit

onMouseDown

(
  • event
)
private

Defined in src/pixi/InteractionManager.js:363

Is called when the mouse button is pressed down on the renderer element

Parameters:

  • event Event

    The DOM event of a mouse button being pressed down

onMouseMove

(
  • event
)
private

Defined in src/pixi/InteractionManager.js:328

Is called when the mouse moves across the renderer element

Parameters:

  • event Event

    The DOM event of the mouse moving

onMouseOut

(
  • event
)
private

Defined in src/pixi/InteractionManager.js:418

Is called when the mouse button is moved out of the renderer element

Parameters:

  • event Event

    The DOM event of a mouse button being moved out

onMouseUp

(
  • event
)
private

Defined in src/pixi/InteractionManager.js:456

Is called when the mouse button is released on the renderer element

Parameters:

  • event Event

    The DOM event of a mouse button being released

onTouchEnd

(
  • event
)
private

Defined in src/pixi/InteractionManager.js:715

Is called when a touch is ended on the renderer element

Parameters:

  • event Event

    The DOM event of a touch ending on the renderer view

onTouchMove

(
  • event
)
private

Defined in src/pixi/InteractionManager.js:611

Is called when a touch is moved across the renderer element

Parameters:

  • event Event

    The DOM event of a touch moving across the renderer view

onTouchStart

(
  • event
)
private

Defined in src/pixi/InteractionManager.js:653

Is called when a touch is started on the renderer element

Parameters:

  • event Event

    The DOM event of a touch starting on the renderer view

setTarget

(
  • target
)
private

Defined in src/pixi/InteractionManager.js:153

Sets the target for event delegation

Parameters:

setTargetDomElement

(
  • domElement
)
private

Defined in src/pixi/InteractionManager.js:175

Sets the DOM element which will receive mouse/touch events. This is useful for when you have other DOM elements on top of the renderers Canvas element. With this you'll be able to delegate another DOM element to receive those events

Parameters:

  • domElement DOMElement

    the DOM element which will receive mouse and touch events

update

() private

Defined in src/pixi/InteractionManager.js:235

updates the state of interactive objects

Properties

currentCursorStyle

String

Defined in src/pixi/InteractionManager.js:88

The css style of the cursor that is being used

interactionDOMElement

HTMLCanvasElement private

Defined in src/pixi/InteractionManager.js:68

Our canvas

interactiveItems

Array private

Defined in src/pixi/InteractionManager.js:59

An array containing all the iterative items from the our interactive tree

mouse

InteractionData

Defined in src/pixi/InteractionManager.js:24

the mouse data

mouseOut

Boolean

Defined in src/pixi/InteractionManager.js:96

Is set to true when the mouse is moved out of the canvas

mouseoverEnabled

Boolean

Defined in src/pixi/InteractionManager.js:43

pool

Array

Defined in src/pixi/InteractionManager.js:51

tiny little interactiveData pool !

stage

Stage

Defined in src/pixi/InteractionManager.js:16

a reference to the stage

touchs

Object

Defined in src/pixi/InteractionManager.js:32

an object that stores current touches (InteractionData) by id reference