Class: InteractionManager

Extends

• EventEmitter

Members

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

currentCursorMode string

The mode of the cursor that is being used. The value of this is a key from the cursorStyles dictionary.

cursorStyles Object.<string, (string|function()|Object.<string, string>)>

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

eventData object

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

interactionFrequency number

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

Default Value:

• 10

mouse PIXI.interaction.InteractionData

The mouse data

moveWhenInside boolean

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 PixiJS used to work. This will be set to true in future versions of pixi.

Default Value:

• false

renderer PIXI.AbstractRenderer

The renderer this interaction manager works for.

resolution number

The current resolution / device pixel ratio.

Default Value:

• 1

supportsPointerEvents boolean readonly

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

supportsTouchEvents boolean readonly

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

Methods

destroy ()

InteractionManager.js:1807

Destroys the interaction manager

hitTest (globalPoint, root)PIXI.DisplayObject

InteractionManager.js:662

Hit tests a point against the display tree, returning the first interactive object that is hit.

Name	Type	Description
globalPoint	PIXI.Point	A point to hit test with, in global space.
root	PIXI.Container	optional The root display object to start from. If omitted, defaults to the last rendered root of the associated renderer.

Returns:

Type	Description
PIXI.DisplayObject	The hit display object, if any.

mapPositionToPoint (point, x, y)

InteractionManager.js:959

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.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

setCursorMode (mode)

InteractionManager.js:887

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, resolution)

InteractionManager.js:688

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 bale to deletegate another DOM element to receive those events.

Name	Type	Default	Description
element	HTMLCanvasElement		the DOM element which will receive mouse and touch events.
resolution	number	1	optional The resolution / device pixel ratio of the new element (relative to the canvas).

update (deltaTime)

InteractionManager.js:823

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