PixiJS

Class: InteractionData

PIXI.InteractionData

Holds all information related to an Interaction event

Members

button number

Indicates which button was pressed on the mouse or pointer device to trigger the event.

Default Value:
  • 0
See:

buttons number

Indicates which buttons are pressed on the mouse or pointer device when the event is triggered.

Default Value:
  • 0
See:

global PIXI.Point

This point stores the global coords of where the touch/mouse event happened

height number

The height of the pointer's contact along the y-axis, measured in CSS pixels. radiusY of TouchEvents will be represented by this value.

Default Value:
  • 0
See:

identifier number

Unique identifier for this interaction

Default Value:
  • undefined

isPrimary Boolean

Indicates whether or not the pointer device that created the event is the primary pointer.

Default Value:
  • false
See:

originalEvent MouseEvent | TouchEvent | PointerEvent

When passed to an event handler, this will be the original DOM Event that was captured

Default Value:
  • undefined
See:

pointerId number readonly

The unique identifier of the pointer. It will be the same as identifier.

See:

pointerType string

The type of pointer that triggered the event.

Default Value:
  • undefined
See:

pressure number

Pressure applied by the pointing device during the event. A Touch's force property will be represented by this value.

Default Value:
  • 0
See:

rotationAngle number

From TouchEvents (not PointerEvents triggered by touches), the rotationAngle of the Touch.

Default Value:
  • 0
See:

tangentialPressure number

Barrel pressure on a stylus pointer.

Default Value:
  • 0
See:

target PIXI.Sprite

The target Sprite that was interacted with

Default Value:
  • undefined

tiltX number

The angle, in degrees, between the pointer device and the screen.

Default Value:
  • 0
See:

tiltY number

The angle, in degrees, between the pointer device and the screen.

Default Value:
  • 0
See:

twist number

Twist of a stylus pointer.

Default Value:
  • 0
See:

width number

The width of the pointer's contact along the x-axis, measured in CSS pixels. radiusX of TouchEvents will be represented by this value.

Default Value:
  • 0
See:

Methods

copyEvent (event) void

InteractionData.ts:181

Copies properties from normalized event data.

Name Type Description
event Touch | MouseEvent | PointerEvent

The normalized event data

getLocalPosition (displayObject, point, globalPos) PIXI.Point

InteractionData.ts:164

This will return the local coordinates of the specified displayObject for this InteractionData

Name Type Attributes Description
displayObject PIXI.DisplayObject

The DisplayObject that you would like the local coords off
point PIXI.Point <optional>

A Point object in which to store the value, optional (otherwise will create a new point)
globalPos PIXI.Point <optional>

A Point object containing your custom global coords, optional (otherwise will use the current global coords)
Returns:
Type Description
PIXI.Point A point containing the coordinates of the InteractionData position relative to the DisplayObject

reset () void

InteractionData.ts:212

Resets the data for pooling.