The interaction manager deals with mouse, touch and pointer 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
Public methods | |
---|---|
public | hitTest(globalPoint: PIXI.Point, root: PIXI.Container): PIXI.DisplayObject |
private | setTargetElement(element: HTMLCanvasElement, resolution: number): void |
private | addEvents(): void |
private | removeEvents(): void |
public | update(deltaTime: number): void |
public | setCursorMode(mode: string): void |
private | dispatchEvent(displayObject: PIXI.Container, PIXI.Sprite, PIXI.extras.TilingSprite, eventString: string, eventData: object): void |
public | mapPositionToPoint(point: PIXI.Point, x: number, y: number): void |
private | processInteractive(interactionEvent: InteractionEvent, displayObject: PIXI.Container, PIXI.Sprite, PIXI.extras.TilingSprite, func: function, hitTest: boolean, interactive: boolean): boolean |
private | onPointerDown(originalEvent: PointerEvent): void |
private | processPointerDown(interactionEvent: InteractionEvent, displayObject: PIXI.Container, PIXI.Sprite, PIXI.extras.TilingSprite, hit: boolean): void |
private | onPointerComplete(originalEvent: PointerEvent, cancelled: boolean, func: function): void |
private | onPointerCancel(event: PointerEvent): void |
private | processPointerCancel(interactionEvent: InteractionEvent, displayObject: PIXI.Container, PIXI.Sprite, PIXI.extras.TilingSprite): void |
private | onPointerUp(event: PointerEvent): void |
private | processPointerUp(interactionEvent: InteractionEvent, displayObject: PIXI.Container, PIXI.Sprite, PIXI.extras.TilingSprite, hit: boolean): void |
private | onPointerMove(originalEvent: PointerEvent): void |
private | processPointerMove(interactionEvent: InteractionEvent, displayObject: PIXI.Container, PIXI.Sprite, PIXI.extras.TilingSprite, hit: boolean): void |
private | onPointerOut(originalEvent: PointerEvent): void |
private | processPointerOverOut(interactionEvent: InteractionEvent, displayObject: PIXI.Container, PIXI.Sprite, PIXI.extras.TilingSprite, hit: boolean): void |
private | onPointerOver(originalEvent: PointerEvent): void |
private | getInteractionDataForPointerId(event: PointerEvent): InteractionData |
private | releaseInteractionDataForPointerId(pointerId: number): void |
private | configureInteractionEventForDOMEvent(interactionEvent: InteractionEvent, pointerEvent: PointerEvent, interactionData: InteractionData): InteractionEvent |
private | normalizeToPointerData(event: TouchEvent, MouseEvent, PointerEvent): Array.<PointerEvent> |
public | destroy(): void |
public | hitTest(globalPoint: PIXI.Point, root: PIXI.Container): PIXI.DisplayObject |
private | setTargetElement(element: HTMLCanvasElement, resolution: number): void |
private | addEvents(): void |
private | removeEvents(): void |
public | update(deltaTime: number): void |
public | setCursorMode(mode: string): void |
private | dispatchEvent(displayObject: PIXI.Container, PIXI.Sprite, PIXI.extras.TilingSprite, eventString: string, eventData: object): void |
public | mapPositionToPoint(point: PIXI.Point, x: number, y: number): void |
private | processInteractive(interactionEvent: InteractionEvent, displayObject: PIXI.Container, PIXI.Sprite, PIXI.extras.TilingSprite, func: function, hitTest: boolean, interactive: boolean): boolean |
private | onPointerDown(originalEvent: PointerEvent): void |
private | processPointerDown(interactionEvent: InteractionEvent, displayObject: PIXI.Container, PIXI.Sprite, PIXI.extras.TilingSprite, hit: boolean): void |
private | onPointerComplete(originalEvent: PointerEvent, cancelled: boolean, func: function): void |
private | onPointerCancel(event: PointerEvent): void |
private | processPointerCancel(interactionEvent: InteractionEvent, displayObject: PIXI.Container, PIXI.Sprite, PIXI.extras.TilingSprite): void |
private | onPointerUp(event: PointerEvent): void |
private | processPointerUp(interactionEvent: InteractionEvent, displayObject: PIXI.Container, PIXI.Sprite, PIXI.extras.TilingSprite, hit: boolean): void |
private | onPointerMove(originalEvent: PointerEvent): void |
private | processPointerMove(interactionEvent: InteractionEvent, displayObject: PIXI.Container, PIXI.Sprite, PIXI.extras.TilingSprite, hit: boolean): void |
private | onPointerOut(originalEvent: PointerEvent): void |
private | processPointerOverOut(interactionEvent: InteractionEvent, displayObject: PIXI.Container, PIXI.Sprite, PIXI.extras.TilingSprite, hit: boolean): void |
private | onPointerOver(originalEvent: PointerEvent): void |
private | getInteractionDataForPointerId(event: PointerEvent): InteractionData |
private | releaseInteractionDataForPointerId(pointerId: number): void |
private | configureInteractionEventForDOMEvent(interactionEvent: InteractionEvent, pointerEvent: PointerEvent, interactionData: InteractionData): InteractionEvent |
private | normalizeToPointerData(event: TouchEvent, MouseEvent, PointerEvent): Array.<PointerEvent> |
public | destroy(): void |
Name | Type | Attribute | Description |
---|---|---|---|
defaultCursorStyle | string | public | |
currentCursorStyle | string | public | |
renderer | PIXI.SystemRenderer | public | The renderer this interaction manager works for. |
autoPreventDefault | boolean | public | Should default browser actions automatically be prevented. |
interactionFrequency | number | public | Frequency in milliseconds that the mousemove, moveover & mouseout interaction events will be checked. |
mouse | PIXI.interaction.InteractionData | public | The mouse data |
activeInteractionData | Object.<number, PIXI.interation.InteractionData> | private | Actively tracked InteractionData |
interactionDataPool |
Array. |
private | Pool of unused InteractionData |
eventData | object | public | An event data object to handle all the event tracking/dispatching |
interactionDOMElement | HTMLElement | private | The DOM element to bind to. |
moveWhenInside | boolean | public | This property determines if mousemove and touchmove events are fired only when the cursor |
eventsAdded | boolean | private | Have events been attached to the dom element? |
mouseOverRenderer | boolean | private | Is the mouse hovering over the renderer? |
supportsTouchEvents | boolean | public | Does the device support touch events |
supportsPointerEvents | boolean | public | Does the device support pointer events |
onPointerUp | function | private | |
onPointerCancel | function | private | |
onPointerDown | function | private | |
onPointerMove | function | private | |
onPointerOut | function | private | |
onPointerOver | function | private | |
cursorStyles | Object.<string, (string|function()|Object.<string, string>)> | public | Dictionary of how different cursor modes are handled. Strings are handled as CSS cursor |
currentCursorMode | string | public | The mode of the cursor that is being used. |
cursor | string | private | Internal cached let. |
_tempPoint | PIXI.Point | private | Internal cached let. |
resolution | number | public | The current resolution / device pixel ratio. |
mousedown | PIXI.interaction.InteractionData | public | Fired when a pointer device button (usually a mouse left-button) is pressed on the display |
rightdown | PIXI.interaction.InteractionData | public | Fired when a pointer device secondary button (usually a mouse right-button) is pressed |
mouseup | PIXI.interaction.InteractionData | public | Fired when a pointer device button (usually a mouse left-button) is released over the display |
rightup | PIXI.interaction.InteractionData | public | Fired when a pointer device secondary button (usually a mouse right-button) is released |
click | PIXI.interaction.InteractionData | public | Fired when a pointer device button (usually a mouse left-button) is pressed and released on |
rightclick | PIXI.interaction.InteractionData | public | Fired when a pointer device secondary button (usually a mouse right-button) is pressed |
mouseupoutside | PIXI.interaction.InteractionData | public | Fired when a pointer device button (usually a mouse left-button) is released outside the |
rightupoutside | PIXI.interaction.InteractionData | public | Fired when a pointer device secondary button (usually a mouse right-button) is released |
mousemove | PIXI.interaction.InteractionData | public | Fired when a pointer device (usually a mouse) is moved while over the display object |
mouseover | PIXI.interaction.InteractionData | public | Fired when a pointer device (usually a mouse) is moved onto the display object |
mouseout | PIXI.interaction.InteractionData | public | Fired when a pointer device (usually a mouse) is moved off the display object |
pointerdown | PIXI.interaction.InteractionData | public | Fired when a pointer device button is pressed on the display object. |
pointerup | PIXI.interaction.InteractionData | public | Fired when a pointer device button is released over the display object. |
pointercancel | public | Fired when the operating system cancels a pointer event |
|
pointertap | PIXI.interaction.InteractionData | public | Fired when a pointer device button is pressed and released on the display object. |
pointerupoutside | PIXI.interaction.InteractionData | public | Fired when a pointer device button is released outside the display object that initially |
pointermove | PIXI.interaction.InteractionData | public | Fired when a pointer device is moved while over the display object |
pointerover | PIXI.interaction.InteractionData | public | Fired when a pointer device is moved onto the display object |
pointerout | PIXI.interaction.InteractionData | public | Fired when a pointer device is moved off the display object |
touchstart | PIXI.interaction.InteractionData | public | Fired when a touch point is placed on the display object. |
touchend | PIXI.interaction.InteractionData | public | Fired when a touch point is removed from the display object. |
touchcancel | public | Fired when the operating system cancels a touch |
|
tap | PIXI.interaction.InteractionData | public | Fired when a touch point is placed and removed from the display object. |
touchendoutside | PIXI.interaction.InteractionData | public | Fired when a touch point is removed outside of the display object that initially |
touchmove | PIXI.interaction.InteractionData | public | Fired when a touch point is moved along the display object. |
defaultCursorStyle | string | public | |
currentCursorStyle | string | public | |
renderer | PIXI.SystemRenderer | public | The renderer this interaction manager works for. |
autoPreventDefault | boolean | public | Should default browser actions automatically be prevented. |
interactionFrequency | number | public | Frequency in milliseconds that the mousemove, moveover & mouseout interaction events will be checked. |
mouse | PIXI.interaction.InteractionData | public | The mouse data |
activeInteractionData | Object.<number, PIXI.interation.InteractionData> | private | Actively tracked InteractionData |
interactionDataPool |
Array. |
private | Pool of unused InteractionData |
eventData | object | public | An event data object to handle all the event tracking/dispatching |
interactionDOMElement | HTMLElement | private | The DOM element to bind to. |
moveWhenInside | boolean | public | This property determines if mousemove and touchmove events are fired only when the cursor |
eventsAdded | boolean | private | Have events been attached to the dom element? |
mouseOverRenderer | boolean | private | Is the mouse hovering over the renderer? |
supportsTouchEvents | boolean | public | Does the device support touch events |
supportsPointerEvents | boolean | public | Does the device support pointer events |
onPointerUp | function | private | |
onPointerCancel | function | private | |
onPointerDown | function | private | |
onPointerMove | function | private | |
onPointerOut | function | private | |
onPointerOver | function | private | |
cursorStyles | Object.<string, (string|function()|Object.<string, string>)> | public | Dictionary of how different cursor modes are handled. Strings are handled as CSS cursor |
currentCursorMode | string | public | The mode of the cursor that is being used. |
cursor | string | private | Internal cached let. |
_tempPoint | PIXI.Point | private | Internal cached let. |
resolution | number | public | The current resolution / device pixel ratio. |
mousedown | PIXI.interaction.InteractionData | public | Fired when a pointer device button (usually a mouse left-button) is pressed on the display |
rightdown | PIXI.interaction.InteractionData | public | Fired when a pointer device secondary button (usually a mouse right-button) is pressed |
mouseup | PIXI.interaction.InteractionData | public | Fired when a pointer device button (usually a mouse left-button) is released over the display |
rightup | PIXI.interaction.InteractionData | public | Fired when a pointer device secondary button (usually a mouse right-button) is released |
click | PIXI.interaction.InteractionData | public | Fired when a pointer device button (usually a mouse left-button) is pressed and released on |
rightclick | PIXI.interaction.InteractionData | public | Fired when a pointer device secondary button (usually a mouse right-button) is pressed |
mouseupoutside | PIXI.interaction.InteractionData | public | Fired when a pointer device button (usually a mouse left-button) is released outside the |
rightupoutside | PIXI.interaction.InteractionData | public | Fired when a pointer device secondary button (usually a mouse right-button) is released |
mousemove | PIXI.interaction.InteractionData | public | Fired when a pointer device (usually a mouse) is moved while over the display object |
mouseover | PIXI.interaction.InteractionData | public | Fired when a pointer device (usually a mouse) is moved onto the display object |
mouseout | PIXI.interaction.InteractionData | public | Fired when a pointer device (usually a mouse) is moved off the display object |
pointerdown | PIXI.interaction.InteractionData | public | Fired when a pointer device button is pressed on the display object. |
pointerup | PIXI.interaction.InteractionData | public | Fired when a pointer device button is released over the display object. |
pointercancel | public | Fired when the operating system cancels a pointer event |
|
pointertap | PIXI.interaction.InteractionData | public | Fired when a pointer device button is pressed and released on the display object. |
pointerupoutside | PIXI.interaction.InteractionData | public | Fired when a pointer device button is released outside the display object that initially |
pointermove | PIXI.interaction.InteractionData | public | Fired when a pointer device is moved while over the display object |
pointerover | PIXI.interaction.InteractionData | public | Fired when a pointer device is moved onto the display object |
pointerout | PIXI.interaction.InteractionData | public | Fired when a pointer device is moved off the display object |
touchstart | PIXI.interaction.InteractionData | public | Fired when a touch point is placed on the display object. |
touchend | PIXI.interaction.InteractionData | public | Fired when a touch point is removed from the display object. |
touchcancel | public | Fired when the operating system cancels a touch |
|
tap | PIXI.interaction.InteractionData | public | Fired when a touch point is placed and removed from the display object. |
touchendoutside | PIXI.interaction.InteractionData | public | Fired when a touch point is removed outside of the display object that initially |
touchmove | PIXI.interaction.InteractionData | public | Fired when a touch point is moved along the display object. |
Hit tests a point against the display tree, returning the first interactive object that is hit.
Name | Type | Attribute | Description |
---|---|---|---|
globalPoint | A point to hit test with, in global space. |
||
root | The root display object to start from. If omitted, defaults |
PIXI.DisplayObject
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 | Attribute | Description |
---|---|---|---|
element | the DOM element which will receive mouse and touch events. |
||
resolution | The resolution / device pixel ratio of the new element (relative to the canvas). |
void
Registers all the DOM events
void
Removes all the DOM events that were previously registered
void
Updates the state of interactive objects.
Invoked by a throttled ticker update from {@link PIXI.ticker.shared}.
Name | Type | Attribute | Description |
---|---|---|---|
deltaTime | time delta since last tick |
void
Sets the current cursor mode, handling any callbacks or CSS style changes.
Name | Type | Attribute | Description |
---|---|---|---|
mode | cursor mode, a key from the cursorStyles dictionary |
void
Dispatches an event on the display object that was interacted with
Name | Type | Attribute | Description |
---|---|---|---|
displayObject | the display object in question |
||
eventString | the name of the event (e.g, mousedown) |
||
eventData | the event data object |
void
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 | Attribute | Description |
---|---|---|---|
point | the point that the result will be stored in |
||
x | the x coord of the position to map |
||
y | the y coord of the position to map |
void
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 | Attribute | Description |
---|---|---|---|
interactionEvent | event containing the point that |
||
displayObject | the displayObject |
||
func | the function that will be called on each interactive object. The |
||
hitTest | this indicates if the objects inside should be hit test against the point |
||
interactive | Whether the displayObject is interactive |
Is called when the pointer button is pressed down on the renderer element
Name | Type | Attribute | Description |
---|---|---|---|
originalEvent | The DOM event of a pointer button being pressed down |
void
Processes the result of the pointer down check and dispatches the event if need be
Name | Type | Attribute | Description |
---|---|---|---|
interactionEvent | The interaction event wrapping the DOM event |
||
displayObject | The display object that was tested |
||
hit | the result of the hit test on the display object |
void
Is called when the pointer button is released on the renderer element
Name | Type | Attribute | Description |
---|---|---|---|
originalEvent | The DOM event of a pointer button being released |
||
cancelled | true if the pointer is cancelled |
||
func | Function passed to {@link processInteractive} |
void
Is called when the pointer button is cancelled
Name | Type | Attribute | Description |
---|---|---|---|
event | The DOM event of a pointer button being released |
void
Processes the result of the pointer cancel check and dispatches the event if need be
Name | Type | Attribute | Description |
---|---|---|---|
interactionEvent | The interaction event wrapping the DOM event |
||
displayObject | The display object that was tested |
void
Is called when the pointer button is released on the renderer element
Name | Type | Attribute | Description |
---|---|---|---|
event | The DOM event of a pointer button being released |
void
Processes the result of the pointer up check and dispatches the event if need be
Name | Type | Attribute | Description |
---|---|---|---|
interactionEvent | The interaction event wrapping the DOM event |
||
displayObject | The display object that was tested |
||
hit | the result of the hit test on the display object |
void
Is called when the pointer moves across the renderer element
Name | Type | Attribute | Description |
---|---|---|---|
originalEvent | The DOM event of a pointer moving |
void
Processes the result of the pointer move check and dispatches the event if need be
Name | Type | Attribute | Description |
---|---|---|---|
interactionEvent | The interaction event wrapping the DOM event |
||
displayObject | The display object that was tested |
||
hit | the result of the hit test on the display object |
void
Is called when the pointer is moved out of the renderer element
Name | Type | Attribute | Description |
---|---|---|---|
originalEvent | The DOM event of a pointer being moved out |
void
Processes the result of the pointer over/out check and dispatches the event if need be
Name | Type | Attribute | Description |
---|---|---|---|
interactionEvent | The interaction event wrapping the DOM event |
||
displayObject | The display object that was tested |
||
hit | the result of the hit test on the display object |
void
Is called when the pointer is moved into the renderer element
Name | Type | Attribute | Description |
---|---|---|---|
originalEvent | The DOM event of a pointer button being moved into the renderer view |
void
Get InteractionData for a given pointerId. Store that data as well
Name | Type | Attribute | Description |
---|---|---|---|
event | Normalized pointer event, output from normalizeToPointerData |
Return unused InteractionData to the pool, for a given pointerId
Name | Type | Attribute | Description |
---|---|---|---|
pointerId | Identifier from a pointer event |
void
Configure an InteractionEvent to wrap a DOM PointerEvent and InteractionData
Name | Type | Attribute | Description |
---|---|---|---|
interactionEvent | The event to be configured |
||
pointerEvent | The DOM event that will be paired with the InteractionEvent |
||
interactionData | The InteractionData that will be paired with the InteractionEvent |
Ensures that the original event object contains all data that a regular pointer event would have
Name | Type | Attribute | Description |
---|---|---|---|
event | The original event data from a touch or mouse event |
Destroys the interaction manager
void
Hit tests a point against the display tree, returning the first interactive object that is hit.
Name | Type | Attribute | Description |
---|---|---|---|
globalPoint | A point to hit test with, in global space. |
||
root | The root display object to start from. If omitted, defaults |
PIXI.DisplayObject
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 | Attribute | Description |
---|---|---|---|
element | the DOM element which will receive mouse and touch events. |
||
resolution | The resolution / device pixel ratio of the new element (relative to the canvas). |
void
Registers all the DOM events
void
Removes all the DOM events that were previously registered
void
Updates the state of interactive objects.
Invoked by a throttled ticker update from {@link PIXI.ticker.shared}.
Name | Type | Attribute | Description |
---|---|---|---|
deltaTime | time delta since last tick |
void
Sets the current cursor mode, handling any callbacks or CSS style changes.
Name | Type | Attribute | Description |
---|---|---|---|
mode | cursor mode, a key from the cursorStyles dictionary |
void
Dispatches an event on the display object that was interacted with
Name | Type | Attribute | Description |
---|---|---|---|
displayObject | the display object in question |
||
eventString | the name of the event (e.g, mousedown) |
||
eventData | the event data object |
void
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 | Attribute | Description |
---|---|---|---|
point | the point that the result will be stored in |
||
x | the x coord of the position to map |
||
y | the y coord of the position to map |
void
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 | Attribute | Description |
---|---|---|---|
interactionEvent | event containing the point that |
||
displayObject | the displayObject |
||
func | the function that will be called on each interactive object. The |
||
hitTest | this indicates if the objects inside should be hit test against the point |
||
interactive | Whether the displayObject is interactive |
Is called when the pointer button is pressed down on the renderer element
Name | Type | Attribute | Description |
---|---|---|---|
originalEvent | The DOM event of a pointer button being pressed down |
void
Processes the result of the pointer down check and dispatches the event if need be
Name | Type | Attribute | Description |
---|---|---|---|
interactionEvent | The interaction event wrapping the DOM event |
||
displayObject | The display object that was tested |
||
hit | the result of the hit test on the display object |
void
Is called when the pointer button is released on the renderer element
Name | Type | Attribute | Description |
---|---|---|---|
originalEvent | The DOM event of a pointer button being released |
||
cancelled | true if the pointer is cancelled |
||
func | Function passed to {@link processInteractive} |
void
Is called when the pointer button is cancelled
Name | Type | Attribute | Description |
---|---|---|---|
event | The DOM event of a pointer button being released |
void
Processes the result of the pointer cancel check and dispatches the event if need be
Name | Type | Attribute | Description |
---|---|---|---|
interactionEvent | The interaction event wrapping the DOM event |
||
displayObject | The display object that was tested |
void
Is called when the pointer button is released on the renderer element
Name | Type | Attribute | Description |
---|---|---|---|
event | The DOM event of a pointer button being released |
void
Processes the result of the pointer up check and dispatches the event if need be
Name | Type | Attribute | Description |
---|---|---|---|
interactionEvent | The interaction event wrapping the DOM event |
||
displayObject | The display object that was tested |
||
hit | the result of the hit test on the display object |
void
Is called when the pointer moves across the renderer element
Name | Type | Attribute | Description |
---|---|---|---|
originalEvent | The DOM event of a pointer moving |
void
Processes the result of the pointer move check and dispatches the event if need be
Name | Type | Attribute | Description |
---|---|---|---|
interactionEvent | The interaction event wrapping the DOM event |
||
displayObject | The display object that was tested |
||
hit | the result of the hit test on the display object |
void
Is called when the pointer is moved out of the renderer element
Name | Type | Attribute | Description |
---|---|---|---|
originalEvent | The DOM event of a pointer being moved out |
void
Processes the result of the pointer over/out check and dispatches the event if need be
Name | Type | Attribute | Description |
---|---|---|---|
interactionEvent | The interaction event wrapping the DOM event |
||
displayObject | The display object that was tested |
||
hit | the result of the hit test on the display object |
void
Is called when the pointer is moved into the renderer element
Name | Type | Attribute | Description |
---|---|---|---|
originalEvent | The DOM event of a pointer button being moved into the renderer view |
void
Get InteractionData for a given pointerId. Store that data as well
Name | Type | Attribute | Description |
---|---|---|---|
event | Normalized pointer event, output from normalizeToPointerData |
Return unused InteractionData to the pool, for a given pointerId
Name | Type | Attribute | Description |
---|---|---|---|
pointerId | Identifier from a pointer event |
void
Configure an InteractionEvent to wrap a DOM PointerEvent and InteractionData
Name | Type | Attribute | Description |
---|---|---|---|
interactionEvent | The event to be configured |
||
pointerEvent | The DOM event that will be paired with the InteractionEvent |
||
interactionData | The InteractionData that will be paired with the InteractionEvent |
Ensures that the original event object contains all data that a regular pointer event would have
Name | Type | Attribute | Description |
---|---|---|---|
event | The original event data from a touch or mouse event |
Destroys the interaction manager
void
Return unused InteractionData to the pool, for a given pointerId
", "access": "private", "params": [ { "type": { "names": [ "number" ] }, "description": "Identifier from a pointer event
", "name": "pointerId" } ], "name": "releaseInteractionDataForPointerId", "longname": "PIXI.interaction.InteractionManager#releaseInteractionDataForPointerId", "kind": "function", "memberof": "PIXI.interaction.InteractionManager", "scope": "instance", "___id": "T000002R005936", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerreleaseInteractionDataForPointerId", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Configure an InteractionEvent to wrap a DOM PointerEvent and InteractionData\n *\n * @private\n * @param {InteractionEvent} interactionEvent - The event to be configured\n * @param {PointerEvent} pointerEvent - The DOM event that will be paired with the InteractionEvent\n * @param {InteractionData} interactionData - The InteractionData that will be paired with the InteractionEvent\n * @return {InteractionEvent} the interaction event that was passed in\n */", "meta": { "range": [ 53250, 54480 ], "filename": "InteractionManager.js", "lineno": 1467, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": { "id": "astnode100064030", "name": "InteractionManager#configureInteractionEventForDOMEvent", "type": "MethodDefinition", "paramnames": [ "interactionEvent", "pointerEvent", "interactionData" ] }, "vars": { "": null } }, "description": "Configure an InteractionEvent to wrap a DOM PointerEvent and InteractionData
", "access": "private", "params": [ { "type": { "names": [ "InteractionEvent" ] }, "description": "The event to be configured
", "name": "interactionEvent" }, { "type": { "names": [ "PointerEvent" ] }, "description": "The DOM event that will be paired with the InteractionEvent
", "name": "pointerEvent" }, { "type": { "names": [ "InteractionData" ] }, "description": "The InteractionData that will be paired with the InteractionEvent
", "name": "interactionData" } ], "returns": [ { "type": { "names": [ "InteractionEvent" ] }, "description": "the interaction event that was passed in
" } ], "name": "configureInteractionEventForDOMEvent", "longname": "PIXI.interaction.InteractionManager#configureInteractionEventForDOMEvent", "kind": "function", "memberof": "PIXI.interaction.InteractionManager", "scope": "instance", "___id": "T000002R005938", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerconfigureInteractionEventForDOMEvent", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Ensures that the original event object contains all data that a regular pointer event would have\n *\n * @private\n * @param {TouchEvent|MouseEvent|PointerEvent} event - The original event data from a touch or mouse event\n * @return {PointerEvent[]} An array containing a single normalized pointer event, in the case of a pointer\n * or mouse event, or a multiple normalized pointer events if there are multiple changed touches\n */", "meta": { "range": [ 54954, 57859 ], "filename": "InteractionManager.js", "lineno": 1503, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": { "id": "astnode100064140", "name": "InteractionManager#normalizeToPointerData", "type": "MethodDefinition", "paramnames": [ "event" ] }, "vars": { "": null } }, "description": "Ensures that the original event object contains all data that a regular pointer event would have
", "access": "private", "params": [ { "type": { "names": [ "TouchEvent", "MouseEvent", "PointerEvent" ] }, "description": "The original event data from a touch or mouse event
", "name": "event" } ], "returns": [ { "type": { "names": [ "Array.An array containing a single normalized pointer event, in the case of a pointer
or mouse event, or a multiple normalized pointer events if there are multiple changed touches
Destroys the interaction manager
", "name": "destroy", "longname": "PIXI.interaction.InteractionManager#destroy", "kind": "function", "memberof": "PIXI.interaction.InteractionManager", "scope": "instance", "params": [], "___id": "T000002R005976", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerdestroy", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Hit tests a point against the display tree, returning the first interactive object that is hit.\n *\n * @param {PIXI.Point} globalPoint - A point to hit test with, in global space.\n * @param {PIXI.Container} [root] - The root display object to start from. If omitted, defaults\n * to the last rendered root of the associated renderer.\n * @return {PIXI.DisplayObject} The hit display object, if any.\n */", "meta": { "range": [ 16625, 17164 ], "filename": "InteractionManager.js", "lineno": 476, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": { "id": "astnode100136023", "name": "InteractionManager#hitTest", "type": "MethodDefinition", "paramnames": [ "globalPoint", "root" ] }, "vars": { "": null } }, "description": "Hit tests a point against the display tree, returning the first interactive object that is hit.
", "params": [ { "type": { "names": [ "PIXI.Point" ] }, "description": "A point to hit test with, in global space.
", "name": "globalPoint" }, { "type": { "names": [ "PIXI.Container" ] }, "optional": true, "description": "The root display object to start from. If omitted, defaults
to the last rendered root of the associated renderer.
The hit display object, if any.
" } ], "name": "hitTest", "longname": "PIXI.interaction.InteractionManager#hitTest", "kind": "function", "memberof": "PIXI.interaction.InteractionManager", "scope": "instance", "___id": "T000002R012721", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerhitTest", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Sets the DOM element which will receive mouse/touch events. This is useful for when you have\n * other DOM elements on top of the renderers Canvas element. With this you'll be bale to deletegate\n * another DOM element to receive those events.\n *\n * @param {HTMLCanvasElement} element - the DOM element which will receive mouse and touch events.\n * @param {number} [resolution=1] - The resolution / device pixel ratio of the new element (relative to the canvas).\n * @private\n */", "meta": { "range": [ 17690, 17885 ], "filename": "InteractionManager.js", "lineno": 503, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": { "id": "astnode100136068", "name": "InteractionManager#setTargetElement", "type": "MethodDefinition", "paramnames": [ "element", "resolution" ] }, "vars": { "": null } }, "description": "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.
the DOM element which will receive mouse and touch events.
", "name": "element" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 1, "description": "The resolution / device pixel ratio of the new element (relative to the canvas).
", "name": "resolution" } ], "access": "private", "name": "setTargetElement", "longname": "PIXI.interaction.InteractionManager#setTargetElement", "kind": "function", "memberof": "PIXI.interaction.InteractionManager", "scope": "instance", "___id": "T000002R012725", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagersetTargetElement", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Registers all the DOM events\n *\n * @private\n */", "meta": { "range": [ 17966, 20558 ], "filename": "InteractionManager.js", "lineno": 519, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": { "id": "astnode100136098", "name": "InteractionManager#addEvents", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "Registers all the DOM events
", "access": "private", "name": "addEvents", "longname": "PIXI.interaction.InteractionManager#addEvents", "kind": "function", "memberof": "PIXI.interaction.InteractionManager", "scope": "instance", "params": [], "___id": "T000002R012728", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManageraddEvents", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Removes all the DOM events that were previously registered\n *\n * @private\n */", "meta": { "range": [ 20669, 22847 ], "filename": "InteractionManager.js", "lineno": 580, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": { "id": "astnode100136360", "name": "InteractionManager#removeEvents", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "Removes all the DOM events that were previously registered
", "access": "private", "name": "removeEvents", "longname": "PIXI.interaction.InteractionManager#removeEvents", "kind": "function", "memberof": "PIXI.interaction.InteractionManager", "scope": "instance", "params": [], "___id": "T000002R012733", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerremoveEvents", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Updates the state of interactive objects.\n * Invoked by a throttled ticker update from {@link PIXI.ticker.shared}.\n *\n * @param {number} deltaTime - time delta since last tick\n */", "meta": { "range": [ 23064, 24869 ], "filename": "InteractionManager.js", "lineno": 636, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": { "id": "astnode100136623", "name": "InteractionManager#update", "type": "MethodDefinition", "paramnames": [ "deltaTime" ] }, "vars": { "": null } }, "description": "Updates the state of interactive objects.
Invoked by a throttled ticker update from {@link PIXI.ticker.shared}.
time delta since last tick
", "name": "deltaTime" } ], "name": "update", "longname": "PIXI.interaction.InteractionManager#update", "kind": "function", "memberof": "PIXI.interaction.InteractionManager", "scope": "instance", "___id": "T000002R012739", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerupdate", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Sets the current cursor mode, handling any callbacks or CSS style changes.\n *\n * @param {string} mode - cursor mode, a key from the cursorStyles dictionary\n */", "meta": { "range": [ 25062, 26162 ], "filename": "InteractionManager.js", "lineno": 700, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": { "id": "astnode100136748", "name": "InteractionManager#setCursorMode", "type": "MethodDefinition", "paramnames": [ "mode" ] }, "vars": { "": null } }, "description": "Sets the current cursor mode, handling any callbacks or CSS style changes.
", "params": [ { "type": { "names": [ "string" ] }, "description": "cursor mode, a key from the cursorStyles dictionary
", "name": "mode" } ], "name": "setCursorMode", "longname": "PIXI.interaction.InteractionManager#setCursorMode", "kind": "function", "memberof": "PIXI.interaction.InteractionManager", "scope": "instance", "___id": "T000002R012747", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagersetCursorMode", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Dispatches an event on the display object that was interacted with\n *\n * @param {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} displayObject - the display object in question\n * @param {string} eventString - the name of the event (e.g, mousedown)\n * @param {object} eventData - the event data object\n * @private\n */", "meta": { "range": [ 26529, 26925 ], "filename": "InteractionManager.js", "lineno": 741, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": { "id": "astnode100136821", "name": "InteractionManager#dispatchEvent", "type": "MethodDefinition", "paramnames": [ "displayObject", "eventString", "eventData" ] }, "vars": { "": null } }, "description": "Dispatches an event on the display object that was interacted with
", "params": [ { "type": { "names": [ "PIXI.Container", "PIXI.Sprite", "PIXI.extras.TilingSprite" ] }, "description": "the display object in question
", "name": "displayObject" }, { "type": { "names": [ "string" ] }, "description": "the name of the event (e.g, mousedown)
", "name": "eventString" }, { "type": { "names": [ "object" ] }, "description": "the event data object
", "name": "eventData" } ], "access": "private", "name": "dispatchEvent", "longname": "PIXI.interaction.InteractionManager#dispatchEvent", "kind": "function", "memberof": "PIXI.interaction.InteractionManager", "scope": "instance", "___id": "T000002R012752", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerdispatchEvent", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Maps x and y coords from a DOM object and maps them correctly to the pixi view. The\n * resulting value is stored in the point. This takes into account the fact that the DOM\n * element could be scaled and positioned anywhere on the screen.\n *\n * @param {PIXI.Point} point - the point that the result will be stored in\n * @param {number} x - the x coord of the position to map\n * @param {number} y - the y coord of the position to map\n */", "meta": { "range": [ 27414, 28058 ], "filename": "InteractionManager.js", "lineno": 766, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": { "id": "astnode100136864", "name": "InteractionManager#mapPositionToPoint", "type": "MethodDefinition", "paramnames": [ "point", "x", "y" ] }, "vars": { "": null } }, "description": "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.
the point that the result will be stored in
", "name": "point" }, { "type": { "names": [ "number" ] }, "description": "the x coord of the position to map
", "name": "x" }, { "type": { "names": [ "number" ] }, "description": "the y coord of the position to map
", "name": "y" } ], "name": "mapPositionToPoint", "longname": "PIXI.interaction.InteractionManager#mapPositionToPoint", "kind": "function", "memberof": "PIXI.interaction.InteractionManager", "scope": "instance", "___id": "T000002R012755", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagermapPositionToPoint", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * This function is provides a neat way of crawling through the scene graph and running a\n * specified function on all interactive objects it finds. It will also take care of hit\n * testing the interactive objects and passes the hit across in the function.\n *\n * @private\n * @param {InteractionEvent} interactionEvent - event containing the point that\n * is tested for collision\n * @param {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} displayObject - the displayObject\n * that will be hit test (recursively crawls its children)\n * @param {Function} [func] - the function that will be called on each interactive object. The\n * interactionEvent, displayObject and hit will be passed to the function\n * @param {boolean} [hitTest] - this indicates if the objects inside should be hit test against the point\n * @param {boolean} [interactive] - Whether the displayObject is interactive\n * @return {boolean} returns true if the displayObject hit the point\n */", "meta": { "range": [ 29096, 34209 ], "filename": "InteractionManager.js", "lineno": 802, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": { "id": "astnode100136963", "name": "InteractionManager#processInteractive", "type": "MethodDefinition", "paramnames": [ "interactionEvent", "displayObject", "func", "hitTest", "interactive" ] }, "vars": { "": null } }, "description": "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.
event containing the point that
is tested for collision
the displayObject
that will be hit test (recursively crawls its children)
the function that will be called on each interactive object. The
interactionEvent, displayObject and hit will be passed to the function
this indicates if the objects inside should be hit test against the point
", "name": "hitTest" }, { "type": { "names": [ "boolean" ] }, "optional": true, "description": "Whether the displayObject is interactive
", "name": "interactive" } ], "returns": [ { "type": { "names": [ "boolean" ] }, "description": "returns true if the displayObject hit the point
" } ], "name": "processInteractive", "longname": "PIXI.interaction.InteractionManager#processInteractive", "kind": "function", "memberof": "PIXI.interaction.InteractionManager", "scope": "instance", "___id": "T000002R012766", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerprocessInteractive", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Is called when the pointer button is pressed down on the renderer element\n *\n * @private\n * @param {PointerEvent} originalEvent - The DOM event of a pointer button being pressed down\n */", "meta": { "range": [ 34433, 36034 ], "filename": "InteractionManager.js", "lineno": 936, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": { "id": "astnode100137212", "name": "InteractionManager#onPointerDown", "type": "MethodDefinition", "paramnames": [ "originalEvent" ] }, "vars": { "": null } }, "description": "Is called when the pointer button is pressed down on the renderer element
", "access": "private", "params": [ { "type": { "names": [ "PointerEvent" ] }, "description": "The DOM event of a pointer button being pressed down
", "name": "originalEvent" } ], "name": "onPointerDown", "longname": "PIXI.interaction.InteractionManager#onPointerDown", "kind": "function", "memberof": "PIXI.interaction.InteractionManager", "scope": "instance", "___id": "T000002R012783", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManageronPointerDown", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Processes the result of the pointer down check and dispatches the event if need be\n *\n * @private\n * @param {InteractionEvent} interactionEvent - The interaction event wrapping the DOM event\n * @param {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} displayObject - The display object that was tested\n * @param {boolean} hit - the result of the hit test on the display object\n */", "meta": { "range": [ 36464, 37664 ], "filename": "InteractionManager.js", "lineno": 989, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": { "id": "astnode100137361", "name": "InteractionManager#processPointerDown", "type": "MethodDefinition", "paramnames": [ "interactionEvent", "displayObject", "hit" ] }, "vars": { "": null } }, "description": "Processes the result of the pointer down check and dispatches the event if need be
", "access": "private", "params": [ { "type": { "names": [ "InteractionEvent" ] }, "description": "The interaction event wrapping the DOM event
", "name": "interactionEvent" }, { "type": { "names": [ "PIXI.Container", "PIXI.Sprite", "PIXI.extras.TilingSprite" ] }, "description": "The display object that was tested
", "name": "displayObject" }, { "type": { "names": [ "boolean" ] }, "description": "the result of the hit test on the display object
", "name": "hit" } ], "name": "processPointerDown", "longname": "PIXI.interaction.InteractionManager#processPointerDown", "kind": "function", "memberof": "PIXI.interaction.InteractionManager", "scope": "instance", "___id": "T000002R012792", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerprocessPointerDown", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Is called when the pointer button is released on the renderer element\n *\n * @private\n * @param {PointerEvent} originalEvent - The DOM event of a pointer button being released\n * @param {boolean} cancelled - true if the pointer is cancelled\n * @param {Function} func - Function passed to {@link processInteractive}\n */", "meta": { "range": [ 38027, 39249 ], "filename": "InteractionManager.js", "lineno": 1033, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": { "id": "astnode100137496", "name": "InteractionManager#onPointerComplete", "type": "MethodDefinition", "paramnames": [ "originalEvent", "cancelled", "func" ] }, "vars": { "": null } }, "description": "Is called when the pointer button is released on the renderer element
", "access": "private", "params": [ { "type": { "names": [ "PointerEvent" ] }, "description": "The DOM event of a pointer button being released
", "name": "originalEvent" }, { "type": { "names": [ "boolean" ] }, "description": "true if the pointer is cancelled
", "name": "cancelled" }, { "type": { "names": [ "function" ] }, "description": "Function passed to {@link processInteractive}
", "name": "func" } ], "name": "onPointerComplete", "longname": "PIXI.interaction.InteractionManager#onPointerComplete", "kind": "function", "memberof": "PIXI.interaction.InteractionManager", "scope": "instance", "___id": "T000002R012799", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManageronPointerComplete", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Is called when the pointer button is cancelled\n *\n * @private\n * @param {PointerEvent} event - The DOM event of a pointer button being released\n */", "meta": { "range": [ 39434, 39540 ], "filename": "InteractionManager.js", "lineno": 1073, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": { "id": "astnode100137642", "name": "InteractionManager#onPointerCancel", "type": "MethodDefinition", "paramnames": [ "event" ] }, "vars": { "": null } }, "description": "Is called when the pointer button is cancelled
", "access": "private", "params": [ { "type": { "names": [ "PointerEvent" ] }, "description": "The DOM event of a pointer button being released
", "name": "event" } ], "name": "onPointerCancel", "longname": "PIXI.interaction.InteractionManager#onPointerCancel", "kind": "function", "memberof": "PIXI.interaction.InteractionManager", "scope": "instance", "___id": "T000002R012808", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManageronPointerCancel", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Processes the result of the pointer cancel check and dispatches the event if need be\n *\n * @private\n * @param {InteractionEvent} interactionEvent - The interaction event wrapping the DOM event\n * @param {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} displayObject - The display object that was tested\n */", "meta": { "range": [ 39893, 40469 ], "filename": "InteractionManager.js", "lineno": 1085, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": { "id": "astnode100137657", "name": "InteractionManager#processPointerCancel", "type": "MethodDefinition", "paramnames": [ "interactionEvent", "displayObject" ] }, "vars": { "": null } }, "description": "Processes the result of the pointer cancel check and dispatches the event if need be
", "access": "private", "params": [ { "type": { "names": [ "InteractionEvent" ] }, "description": "The interaction event wrapping the DOM event
", "name": "interactionEvent" }, { "type": { "names": [ "PIXI.Container", "PIXI.Sprite", "PIXI.extras.TilingSprite" ] }, "description": "The display object that was tested
", "name": "displayObject" } ], "name": "processPointerCancel", "longname": "PIXI.interaction.InteractionManager#processPointerCancel", "kind": "function", "memberof": "PIXI.interaction.InteractionManager", "scope": "instance", "___id": "T000002R012809", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerprocessPointerCancel", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Is called when the pointer button is released on the renderer element\n *\n * @private\n * @param {PointerEvent} event - The DOM event of a pointer button being released\n */", "meta": { "range": [ 40677, 40776 ], "filename": "InteractionManager.js", "lineno": 1109, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": { "id": "astnode100137724", "name": "InteractionManager#onPointerUp", "type": "MethodDefinition", "paramnames": [ "event" ] }, "vars": { "": null } }, "description": "Is called when the pointer button is released on the renderer element
", "access": "private", "params": [ { "type": { "names": [ "PointerEvent" ] }, "description": "The DOM event of a pointer button being released
", "name": "event" } ], "name": "onPointerUp", "longname": "PIXI.interaction.InteractionManager#onPointerUp", "kind": "function", "memberof": "PIXI.interaction.InteractionManager", "scope": "instance", "___id": "T000002R012812", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManageronPointerUp", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Processes the result of the pointer up check and dispatches the event if need be\n *\n * @private\n * @param {InteractionEvent} interactionEvent - The interaction event wrapping the DOM event\n * @param {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} displayObject - The display object that was tested\n * @param {boolean} hit - the result of the hit test on the display object\n */", "meta": { "range": [ 41204, 44042 ], "filename": "InteractionManager.js", "lineno": 1122, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": { "id": "astnode100137739", "name": "InteractionManager#processPointerUp", "type": "MethodDefinition", "paramnames": [ "interactionEvent", "displayObject", "hit" ] }, "vars": { "": null } }, "description": "Processes the result of the pointer up check and dispatches the event if need be
", "access": "private", "params": [ { "type": { "names": [ "InteractionEvent" ] }, "description": "The interaction event wrapping the DOM event
", "name": "interactionEvent" }, { "type": { "names": [ "PIXI.Container", "PIXI.Sprite", "PIXI.extras.TilingSprite" ] }, "description": "The display object that was tested
", "name": "displayObject" }, { "type": { "names": [ "boolean" ] }, "description": "the result of the hit test on the display object
", "name": "hit" } ], "name": "processPointerUp", "longname": "PIXI.interaction.InteractionManager#processPointerUp", "kind": "function", "memberof": "PIXI.interaction.InteractionManager", "scope": "instance", "___id": "T000002R012813", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerprocessPointerUp", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Is called when the pointer moves across the renderer element\n *\n * @private\n * @param {PointerEvent} originalEvent - The DOM event of a pointer moving\n */", "meta": { "range": [ 44234, 45609 ], "filename": "InteractionManager.js", "lineno": 1208, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": { "id": "astnode100137993", "name": "InteractionManager#onPointerMove", "type": "MethodDefinition", "paramnames": [ "originalEvent" ] }, "vars": { "": null } }, "description": "Is called when the pointer moves across the renderer element
", "access": "private", "params": [ { "type": { "names": [ "PointerEvent" ] }, "description": "The DOM event of a pointer moving
", "name": "originalEvent" } ], "name": "onPointerMove", "longname": "PIXI.interaction.InteractionManager#onPointerMove", "kind": "function", "memberof": "PIXI.interaction.InteractionManager", "scope": "instance", "___id": "T000002R012826", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManageronPointerMove", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Processes the result of the pointer move check and dispatches the event if need be\n *\n * @private\n * @param {InteractionEvent} interactionEvent - The interaction event wrapping the DOM event\n * @param {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} displayObject - The display object that was tested\n * @param {boolean} hit - the result of the hit test on the display object\n */", "meta": { "range": [ 46039, 46766 ], "filename": "InteractionManager.js", "lineno": 1260, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": { "id": "astnode100138156", "name": "InteractionManager#processPointerMove", "type": "MethodDefinition", "paramnames": [ "interactionEvent", "displayObject", "hit" ] }, "vars": { "": null } }, "description": "Processes the result of the pointer move check and dispatches the event if need be
", "access": "private", "params": [ { "type": { "names": [ "InteractionEvent" ] }, "description": "The interaction event wrapping the DOM event
", "name": "interactionEvent" }, { "type": { "names": [ "PIXI.Container", "PIXI.Sprite", "PIXI.extras.TilingSprite" ] }, "description": "The display object that was tested
", "name": "displayObject" }, { "type": { "names": [ "boolean" ] }, "description": "the result of the hit test on the display object
", "name": "hit" } ], "name": "processPointerMove", "longname": "PIXI.interaction.InteractionManager#processPointerMove", "kind": "function", "memberof": "PIXI.interaction.InteractionManager", "scope": "instance", "___id": "T000002R012837", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerprocessPointerMove", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Is called when the pointer is moved out of the renderer element\n *\n * @private\n * @param {PointerEvent} originalEvent - The DOM event of a pointer being moved out\n */", "meta": { "range": [ 46970, 48130 ], "filename": "InteractionManager.js", "lineno": 1287, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": { "id": "astnode100138246", "name": "InteractionManager#onPointerOut", "type": "MethodDefinition", "paramnames": [ "originalEvent" ] }, "vars": { "": null } }, "description": "Is called when the pointer is moved out of the renderer element
", "access": "private", "params": [ { "type": { "names": [ "PointerEvent" ] }, "description": "The DOM event of a pointer being moved out
", "name": "originalEvent" } ], "name": "onPointerOut", "longname": "PIXI.interaction.InteractionManager#onPointerOut", "kind": "function", "memberof": "PIXI.interaction.InteractionManager", "scope": "instance", "___id": "T000002R012841", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManageronPointerOut", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Processes the result of the pointer over/out check and dispatches the event if need be\n *\n * @private\n * @param {InteractionEvent} interactionEvent - The interaction event wrapping the DOM event\n * @param {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} displayObject - The display object that was tested\n * @param {boolean} hit - the result of the hit test on the display object\n */", "meta": { "range": [ 48564, 50387 ], "filename": "InteractionManager.js", "lineno": 1329, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": { "id": "astnode100138357", "name": "InteractionManager#processPointerOverOut", "type": "MethodDefinition", "paramnames": [ "interactionEvent", "displayObject", "hit" ] }, "vars": { "": null } }, "description": "Processes the result of the pointer over/out check and dispatches the event if need be
", "access": "private", "params": [ { "type": { "names": [ "InteractionEvent" ] }, "description": "The interaction event wrapping the DOM event
", "name": "interactionEvent" }, { "type": { "names": [ "PIXI.Container", "PIXI.Sprite", "PIXI.extras.TilingSprite" ] }, "description": "The display object that was tested
", "name": "displayObject" }, { "type": { "names": [ "boolean" ] }, "description": "the result of the hit test on the display object
", "name": "hit" } ], "name": "processPointerOverOut", "longname": "PIXI.interaction.InteractionManager#processPointerOverOut", "kind": "function", "memberof": "PIXI.interaction.InteractionManager", "scope": "instance", "___id": "T000002R012848", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerprocessPointerOverOut", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Is called when the pointer is moved into the renderer element\n *\n * @private\n * @param {PointerEvent} originalEvent - The DOM event of a pointer button being moved into the renderer view\n */", "meta": { "range": [ 50615, 51373 ], "filename": "InteractionManager.js", "lineno": 1388, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": { "id": "astnode100138530", "name": "InteractionManager#onPointerOver", "type": "MethodDefinition", "paramnames": [ "originalEvent" ] }, "vars": { "": null } }, "description": "Is called when the pointer is moved into the renderer element
", "access": "private", "params": [ { "type": { "names": [ "PointerEvent" ] }, "description": "The DOM event of a pointer button being moved into the renderer view
", "name": "originalEvent" } ], "name": "onPointerOver", "longname": "PIXI.interaction.InteractionManager#onPointerOver", "kind": "function", "memberof": "PIXI.interaction.InteractionManager", "scope": "instance", "___id": "T000002R012858", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManageronPointerOver", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Get InteractionData for a given pointerId. Store that data as well\n *\n * @private\n * @param {PointerEvent} event - Normalized pointer event, output from normalizeToPointerData\n * @return {InteractionData} - Interaction data for the given pointer identifier\n */", "meta": { "range": [ 51675, 52267 ], "filename": "InteractionManager.js", "lineno": 1420, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": { "id": "astnode100138611", "name": "InteractionManager#getInteractionDataForPointerId", "type": "MethodDefinition", "paramnames": [ "event" ] }, "vars": { "": null } }, "description": "Get InteractionData for a given pointerId. Store that data as well
", "access": "private", "params": [ { "type": { "names": [ "PointerEvent" ] }, "description": "Normalized pointer event, output from normalizeToPointerData
", "name": "event" } ], "returns": [ { "type": { "names": [ "InteractionData" ] }, "description": "Return unused InteractionData to the pool, for a given pointerId
", "access": "private", "params": [ { "type": { "names": [ "number" ] }, "description": "Identifier from a pointer event
", "name": "pointerId" } ], "name": "releaseInteractionDataForPointerId", "longname": "PIXI.interaction.InteractionManager#releaseInteractionDataForPointerId", "kind": "function", "memberof": "PIXI.interaction.InteractionManager", "scope": "instance", "___id": "T000002R012870", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerreleaseInteractionDataForPointerId", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Configure an InteractionEvent to wrap a DOM PointerEvent and InteractionData\n *\n * @private\n * @param {InteractionEvent} interactionEvent - The event to be configured\n * @param {PointerEvent} pointerEvent - The DOM event that will be paired with the InteractionEvent\n * @param {InteractionData} interactionData - The InteractionData that will be paired with the InteractionEvent\n * @return {InteractionEvent} the interaction event that was passed in\n */", "meta": { "range": [ 53250, 54480 ], "filename": "InteractionManager.js", "lineno": 1467, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": { "id": "astnode100138709", "name": "InteractionManager#configureInteractionEventForDOMEvent", "type": "MethodDefinition", "paramnames": [ "interactionEvent", "pointerEvent", "interactionData" ] }, "vars": { "": null } }, "description": "Configure an InteractionEvent to wrap a DOM PointerEvent and InteractionData
", "access": "private", "params": [ { "type": { "names": [ "InteractionEvent" ] }, "description": "The event to be configured
", "name": "interactionEvent" }, { "type": { "names": [ "PointerEvent" ] }, "description": "The DOM event that will be paired with the InteractionEvent
", "name": "pointerEvent" }, { "type": { "names": [ "InteractionData" ] }, "description": "The InteractionData that will be paired with the InteractionEvent
", "name": "interactionData" } ], "returns": [ { "type": { "names": [ "InteractionEvent" ] }, "description": "the interaction event that was passed in
" } ], "name": "configureInteractionEventForDOMEvent", "longname": "PIXI.interaction.InteractionManager#configureInteractionEventForDOMEvent", "kind": "function", "memberof": "PIXI.interaction.InteractionManager", "scope": "instance", "___id": "T000002R012872", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerconfigureInteractionEventForDOMEvent", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Ensures that the original event object contains all data that a regular pointer event would have\n *\n * @private\n * @param {TouchEvent|MouseEvent|PointerEvent} event - The original event data from a touch or mouse event\n * @return {PointerEvent[]} An array containing a single normalized pointer event, in the case of a pointer\n * or mouse event, or a multiple normalized pointer events if there are multiple changed touches\n */", "meta": { "range": [ 54954, 57859 ], "filename": "InteractionManager.js", "lineno": 1503, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": { "id": "astnode100138819", "name": "InteractionManager#normalizeToPointerData", "type": "MethodDefinition", "paramnames": [ "event" ] }, "vars": { "": null } }, "description": "Ensures that the original event object contains all data that a regular pointer event would have
", "access": "private", "params": [ { "type": { "names": [ "TouchEvent", "MouseEvent", "PointerEvent" ] }, "description": "The original event data from a touch or mouse event
", "name": "event" } ], "returns": [ { "type": { "names": [ "Array.An array containing a single normalized pointer event, in the case of a pointer
or mouse event, or a multiple normalized pointer events if there are multiple changed touches
Destroys the interaction manager
", "name": "destroy", "longname": "PIXI.interaction.InteractionManager#destroy", "kind": "function", "memberof": "PIXI.interaction.InteractionManager", "scope": "instance", "params": [], "___id": "T000002R012910", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerdestroy", "filepath": "interaction\\InteractionManager.js" } ], "$attributes": [ { "comment": "/**\n * @name PIXI.interaction.InteractionManager#defaultCursorStyle\n * @static\n * @type {string}\n * @see PIXI.interaction.InteractionManager#cursorStyles\n * @deprecated since 4.3.0\n */", "meta": { "range": [ 29007, 29191 ], "filename": "deprecation.js", "lineno": 1085, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src", "code": {} }, "name": "defaultCursorStyle", "scope": "instance", "type": { "names": [ "string" ] }, "see": [ "PIXI.interaction.InteractionManager#cursorStyles" ], "deprecated": "since 4.3.0", "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#defaultCursorStyle", "kind": "member", "___id": "T000002R004728", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerdefaultCursorStyle", "filepath": "deprecation.js" }, { "comment": "/**\n * @name PIXI.interaction.InteractionManager#currentCursorStyle\n * @static\n * @type {string}\n * @see PIXI.interaction.InteractionManager#cursorStyles\n * @deprecated since 4.3.0\n */", "meta": { "range": [ 29602, 29786 ], "filename": "deprecation.js", "lineno": 1106, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src", "code": {} }, "name": "currentCursorStyle", "scope": "instance", "type": { "names": [ "string" ] }, "see": [ "PIXI.interaction.InteractionManager#cursorStyles" ], "deprecated": "since 4.3.0", "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#currentCursorStyle", "kind": "member", "___id": "T000002R004732", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagercurrentCursorStyle", "filepath": "deprecation.js" }, { "comment": "/**\n * The renderer this interaction manager works for.\n *\n * @member {PIXI.SystemRenderer} PIXI.interaction.InteractionManager#renderer\n */", "meta": { "range": [ 1657, 1829 ], "filename": "InteractionManager.js", "lineno": 51, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "The renderer this interaction manager works for.
", "kind": "member", "name": "renderer", "type": { "names": [ "PIXI.SystemRenderer" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#renderer", "scope": "instance", "___id": "T000002R005705", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerrenderer", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Should default browser actions automatically be prevented.\n * Does not apply to pointer events for backwards compatibility\n * preventDefault on pointer events stops mouse events from firing\n * Thus, for every pointer event, there will always be either a mouse of touch event alongside it.\n *\n * @member {boolean} PIXI.interaction.InteractionManager#autoPreventDefault\n * @default true\n */", "meta": { "range": [ 1873, 2332 ], "filename": "InteractionManager.js", "lineno": 58, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "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.
Frequency in milliseconds that the mousemove, moveover & mouseout interaction events will be checked.
", "kind": "member", "name": "interactionFrequency", "type": { "names": [ "number" ] }, "defaultvalue": "10", "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#interactionFrequency", "scope": "instance", "___id": "T000002R005709", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerinteractionFrequency", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * The mouse data\n *\n * @member {PIXI.interaction.InteractionData} PIXI.interaction.InteractionManager#mouse\n */", "meta": { "range": [ 2783, 2931 ], "filename": "InteractionManager.js", "lineno": 77, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "The mouse data
", "kind": "member", "name": "mouse", "type": { "names": [ "PIXI.interaction.InteractionData" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#mouse", "scope": "instance", "___id": "T000002R005711", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagermouse", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Actively tracked InteractionData\n *\n * @private\n * @member {Object.Actively tracked InteractionData
", "access": "private", "kind": "member", "name": "activeInteractionData", "type": { "names": [ "Object.Pool of unused InteractionData
", "access": "private", "kind": "member", "name": "interactionDataPool", "type": { "names": [ "Array.An event data object to handle all the event tracking/dispatching
", "kind": "member", "name": "eventData", "type": { "names": [ "object" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#eventData", "scope": "instance", "___id": "T000002R005719", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagereventData", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * The DOM element to bind to.\n *\n * @private\n * @member {HTMLElement} PIXI.interaction.InteractionManager#interactionDOMElement\n */", "meta": { "range": [ 4041, 4217 ], "filename": "InteractionManager.js", "lineno": 113, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "The DOM element to bind to.
", "access": "private", "kind": "member", "name": "interactionDOMElement", "type": { "names": [ "HTMLElement" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#interactionDOMElement", "scope": "instance", "___id": "T000002R005721", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerinteractionDOMElement", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * This property determines if mousemove and touchmove events are fired only when the cursor\n * is over the object.\n * Setting to true will make things work more in line with how the DOM verison works.\n * Setting to false can make things easier for things like dragging\n * It is currently set to false as this is how pixi used to work. This will be set to true in\n * future versions of pixi.\n *\n * @member {boolean} PIXI.interaction.InteractionManager#moveWhenInside\n * @default false\n */", "meta": { "range": [ 4270, 4842 ], "filename": "InteractionManager.js", "lineno": 121, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "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.
Have events been attached to the dom element?
", "access": "private", "kind": "member", "name": "eventsAdded", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#eventsAdded", "scope": "instance", "___id": "T000002R005725", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagereventsAdded", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Is the mouse hovering over the renderer?\n *\n * @private\n * @member {boolean} PIXI.interaction.InteractionManager#mouseOverRenderer\n */", "meta": { "range": [ 5113, 5294 ], "filename": "InteractionManager.js", "lineno": 142, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Is the mouse hovering over the renderer?
", "access": "private", "kind": "member", "name": "mouseOverRenderer", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#mouseOverRenderer", "scope": "instance", "___id": "T000002R005727", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagermouseOverRenderer", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Does the device support touch events\n * https://www.w3.org/TR/touch-events/\n *\n * @readonly\n * @member {boolean} PIXI.interaction.InteractionManager#supportsTouchEvents\n */", "meta": { "range": [ 5344, 5571 ], "filename": "InteractionManager.js", "lineno": 150, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Does the device support touch events
https://www.w3.org/TR/touch-events/
Does the device support pointer events
https://www.w3.org/Submission/pointer-events/
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.
The mode of the cursor that is being used.
The value of this is a key from the cursorStyles dictionary.
Internal cached let.
", "access": "private", "kind": "member", "name": "cursor", "type": { "names": [ "string" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#cursor", "scope": "instance", "___id": "T000002R005756", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagercursor", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Internal cached let.\n *\n * @private\n * @member {PIXI.Point} PIXI.interaction.InteractionManager#_tempPoint\n */", "meta": { "range": [ 8569, 8726 ], "filename": "InteractionManager.js", "lineno": 239, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Internal cached let.
", "access": "private", "kind": "member", "name": "_tempPoint", "type": { "names": [ "PIXI.Point" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#_tempPoint", "scope": "instance", "___id": "T000002R005758", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManager_tempPoint", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * The current resolution / device pixel ratio.\n *\n * @member {number} PIXI.interaction.InteractionManager#resolution\n * @default 1\n */", "meta": { "range": [ 8780, 8959 ], "filename": "InteractionManager.js", "lineno": 247, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "The current resolution / device pixel ratio.
", "kind": "member", "name": "resolution", "type": { "names": [ "number" ] }, "defaultvalue": "1", "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#resolution", "scope": "instance", "___id": "T000002R005760", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerresolution", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Fired when a pointer device button (usually a mouse left-button) is pressed on the display\n * object.\n *\n * @event mousedown\n * @type {PIXI.interaction.InteractionData}\n * @memberof PIXI.interaction.InteractionManager#\n */", "meta": { "range": [ 9076, 9361 ], "filename": "InteractionManager.js", "lineno": 257, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Fired when a pointer device button (usually a mouse left-button) is pressed 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 button (usually a mouse left-button) is released over 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 button (usually a mouse left-button) is pressed and released on
the display object.
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 button (usually a mouse left-button) is released outside the
display object that initially registered a
[mousedown]{@link PIXI.interaction.InteractionManager#event:mousedown}.
Fired when a pointer device secondary button (usually a mouse right-button) is released
outside the display object that initially registered a
[rightdown]{@link PIXI.interaction.InteractionManager#event:rightdown}.
Fired when a pointer device (usually a mouse) is moved while over the display object
", "kind": "event", "name": "mousemove", "type": { "names": [ "PIXI.interaction.InteractionData" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#event:mousemove", "scope": "instance", "___id": "T000002R005770", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerevent:mousemove", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Fired when a pointer device (usually a mouse) is moved onto the display object\n *\n * @event mouseover\n * @type {PIXI.interaction.InteractionData}\n * @memberof PIXI.interaction.InteractionManager#\n */", "meta": { "range": [ 12017, 12271 ], "filename": "InteractionManager.js", "lineno": 339, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Fired when a pointer device (usually a mouse) is moved onto the display object
", "kind": "event", "name": "mouseover", "type": { "names": [ "PIXI.interaction.InteractionData" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#event:mouseover", "scope": "instance", "___id": "T000002R005771", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerevent:mouseover", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Fired when a pointer device (usually a mouse) is moved off the display object\n *\n * @event mouseout\n * @type {PIXI.interaction.InteractionData}\n * @memberof PIXI.interaction.InteractionManager#\n */", "meta": { "range": [ 12281, 12533 ], "filename": "InteractionManager.js", "lineno": 347, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Fired when a pointer device (usually a mouse) is moved off the display object
", "kind": "event", "name": "mouseout", "type": { "names": [ "PIXI.interaction.InteractionData" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#event:mouseout", "scope": "instance", "___id": "T000002R005772", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerevent:mouseout", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Fired when a pointer device button is pressed on the display object.\n *\n * @event pointerdown\n * @type {PIXI.interaction.InteractionData}\n * @memberof PIXI.interaction.InteractionManager#\n */", "meta": { "range": [ 12543, 12789 ], "filename": "InteractionManager.js", "lineno": 355, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Fired when a pointer device button is pressed on the display object.
", "kind": "event", "name": "pointerdown", "type": { "names": [ "PIXI.interaction.InteractionData" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#event:pointerdown", "scope": "instance", "___id": "T000002R005773", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerevent:pointerdown", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Fired when a pointer device button is released over the display object.\n *\n * @event pointerup\n * @type {PIXI.interaction.InteractionData}\n * @memberof PIXI.interaction.InteractionManager#\n */", "meta": { "range": [ 12799, 13046 ], "filename": "InteractionManager.js", "lineno": 363, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Fired when a pointer device button is released over the display object.
", "kind": "event", "name": "pointerup", "type": { "names": [ "PIXI.interaction.InteractionData" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#event:pointerup", "scope": "instance", "___id": "T000002R005774", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerevent:pointerup", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Fired when the operating system cancels a pointer event\n *\n * @event pointercancel\n * @memberof PIXI.interaction.InteractionManager#\n */", "meta": { "range": [ 13056, 13239 ], "filename": "InteractionManager.js", "lineno": 371, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Fired when the operating system cancels a pointer event
", "kind": "event", "name": "pointercancel", "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#event:pointercancel", "scope": "instance", "___id": "T000002R005775", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerevent:pointercancel", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Fired when a pointer device button is pressed and released on the display object.\n *\n * @event pointertap\n * @type {PIXI.interaction.InteractionData}\n * @memberof PIXI.interaction.InteractionManager#\n */", "meta": { "range": [ 13249, 13507 ], "filename": "InteractionManager.js", "lineno": 378, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Fired when a pointer device button is pressed and released on the display object.
", "kind": "event", "name": "pointertap", "type": { "names": [ "PIXI.interaction.InteractionData" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#event:pointertap", "scope": "instance", "___id": "T000002R005776", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerevent:pointertap", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Fired when a pointer device button is released outside the display object that initially\n * registered a [pointerdown]{@link PIXI.interaction.InteractionManager#event:pointerdown}.\n *\n * @event pointerupoutside\n * @type {PIXI.interaction.InteractionData}\n * @memberof PIXI.interaction.InteractionManager#\n */", "meta": { "range": [ 13517, 13888 ], "filename": "InteractionManager.js", "lineno": 386, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Fired when a pointer device button is released outside the display object that initially
registered a [pointerdown]{@link PIXI.interaction.InteractionManager#event:pointerdown}.
Fired when a pointer device is moved while over the display object
", "kind": "event", "name": "pointermove", "type": { "names": [ "PIXI.interaction.InteractionData" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#event:pointermove", "scope": "instance", "___id": "T000002R005778", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerevent:pointermove", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Fired when a pointer device is moved onto the display object\n *\n * @event pointerover\n * @type {PIXI.interaction.InteractionData}\n * @memberof PIXI.interaction.InteractionManager#\n */", "meta": { "range": [ 14152, 14390 ], "filename": "InteractionManager.js", "lineno": 403, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Fired when a pointer device is moved onto the display object
", "kind": "event", "name": "pointerover", "type": { "names": [ "PIXI.interaction.InteractionData" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#event:pointerover", "scope": "instance", "___id": "T000002R005779", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerevent:pointerover", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Fired when a pointer device is moved off the display object\n *\n * @event pointerout\n * @type {PIXI.interaction.InteractionData}\n * @memberof PIXI.interaction.InteractionManager#\n */", "meta": { "range": [ 14400, 14636 ], "filename": "InteractionManager.js", "lineno": 411, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Fired when a pointer device is moved off the display object
", "kind": "event", "name": "pointerout", "type": { "names": [ "PIXI.interaction.InteractionData" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#event:pointerout", "scope": "instance", "___id": "T000002R005780", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerevent:pointerout", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Fired when a touch point is placed on the display object.\n *\n * @event touchstart\n * @type {PIXI.interaction.InteractionData}\n * @memberof PIXI.interaction.InteractionManager#\n */", "meta": { "range": [ 14646, 14880 ], "filename": "InteractionManager.js", "lineno": 419, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Fired when a touch point is placed on the display object.
", "kind": "event", "name": "touchstart", "type": { "names": [ "PIXI.interaction.InteractionData" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#event:touchstart", "scope": "instance", "___id": "T000002R005781", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerevent:touchstart", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Fired when a touch point is removed from the display object.\n *\n * @event touchend\n * @type {PIXI.interaction.InteractionData}\n * @memberof PIXI.interaction.InteractionManager#\n */", "meta": { "range": [ 14890, 15125 ], "filename": "InteractionManager.js", "lineno": 427, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Fired when a touch point is removed from the display object.
", "kind": "event", "name": "touchend", "type": { "names": [ "PIXI.interaction.InteractionData" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#event:touchend", "scope": "instance", "___id": "T000002R005782", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerevent:touchend", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Fired when the operating system cancels a touch\n *\n * @event touchcancel\n * @memberof PIXI.interaction.InteractionManager#\n */", "meta": { "range": [ 15135, 15308 ], "filename": "InteractionManager.js", "lineno": 435, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Fired when the operating system cancels a touch
", "kind": "event", "name": "touchcancel", "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#event:touchcancel", "scope": "instance", "___id": "T000002R005783", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerevent:touchcancel", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Fired when a touch point is placed and removed from the display object.\n *\n * @event tap\n * @type {PIXI.interaction.InteractionData}\n * @memberof PIXI.interaction.InteractionManager#\n */", "meta": { "range": [ 15318, 15559 ], "filename": "InteractionManager.js", "lineno": 442, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Fired when a touch point is placed and removed from the display object.
", "kind": "event", "name": "tap", "type": { "names": [ "PIXI.interaction.InteractionData" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#event:tap", "scope": "instance", "___id": "T000002R005784", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerevent:tap", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Fired when a touch point is removed outside of the display object that initially\n * registered a [touchstart]{@link PIXI.interaction.InteractionManager#event:touchstart}.\n *\n * @event touchendoutside\n * @type {PIXI.interaction.InteractionData}\n * @memberof PIXI.interaction.InteractionManager#\n */", "meta": { "range": [ 15569, 15929 ], "filename": "InteractionManager.js", "lineno": 450, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Fired when a touch point is removed outside of the display object that initially
registered a [touchstart]{@link PIXI.interaction.InteractionManager#event:touchstart}.
Fired when a touch point is moved along the display object.
", "kind": "event", "name": "touchmove", "type": { "names": [ "PIXI.interaction.InteractionData" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#event:touchmove", "scope": "instance", "___id": "T000002R005786", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerevent:touchmove", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * @name PIXI.interaction.InteractionManager#defaultCursorStyle\n * @static\n * @type {string}\n * @see PIXI.interaction.InteractionManager#cursorStyles\n * @deprecated since 4.3.0\n */", "meta": { "range": [ 29007, 29191 ], "filename": "deprecation.js", "lineno": 1085, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src", "code": {} }, "name": "defaultCursorStyle", "scope": "instance", "type": { "names": [ "string" ] }, "see": [ "PIXI.interaction.InteractionManager#cursorStyles" ], "deprecated": "since 4.3.0", "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#defaultCursorStyle", "kind": "member", "___id": "T000002R011662", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerdefaultCursorStyle", "filepath": "deprecation.js" }, { "comment": "/**\n * @name PIXI.interaction.InteractionManager#currentCursorStyle\n * @static\n * @type {string}\n * @see PIXI.interaction.InteractionManager#cursorStyles\n * @deprecated since 4.3.0\n */", "meta": { "range": [ 29602, 29786 ], "filename": "deprecation.js", "lineno": 1106, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src", "code": {} }, "name": "currentCursorStyle", "scope": "instance", "type": { "names": [ "string" ] }, "see": [ "PIXI.interaction.InteractionManager#cursorStyles" ], "deprecated": "since 4.3.0", "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#currentCursorStyle", "kind": "member", "___id": "T000002R011666", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagercurrentCursorStyle", "filepath": "deprecation.js" }, { "comment": "/**\n * The renderer this interaction manager works for.\n *\n * @member {PIXI.SystemRenderer} PIXI.interaction.InteractionManager#renderer\n */", "meta": { "range": [ 1657, 1829 ], "filename": "InteractionManager.js", "lineno": 51, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "The renderer this interaction manager works for.
", "kind": "member", "name": "renderer", "type": { "names": [ "PIXI.SystemRenderer" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#renderer", "scope": "instance", "___id": "T000002R012639", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerrenderer", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Should default browser actions automatically be prevented.\n * Does not apply to pointer events for backwards compatibility\n * preventDefault on pointer events stops mouse events from firing\n * Thus, for every pointer event, there will always be either a mouse of touch event alongside it.\n *\n * @member {boolean} PIXI.interaction.InteractionManager#autoPreventDefault\n * @default true\n */", "meta": { "range": [ 1873, 2332 ], "filename": "InteractionManager.js", "lineno": 58, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "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.
Frequency in milliseconds that the mousemove, moveover & mouseout interaction events will be checked.
", "kind": "member", "name": "interactionFrequency", "type": { "names": [ "number" ] }, "defaultvalue": "10", "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#interactionFrequency", "scope": "instance", "___id": "T000002R012643", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerinteractionFrequency", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * The mouse data\n *\n * @member {PIXI.interaction.InteractionData} PIXI.interaction.InteractionManager#mouse\n */", "meta": { "range": [ 2783, 2931 ], "filename": "InteractionManager.js", "lineno": 77, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "The mouse data
", "kind": "member", "name": "mouse", "type": { "names": [ "PIXI.interaction.InteractionData" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#mouse", "scope": "instance", "___id": "T000002R012645", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagermouse", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Actively tracked InteractionData\n *\n * @private\n * @member {Object.Actively tracked InteractionData
", "access": "private", "kind": "member", "name": "activeInteractionData", "type": { "names": [ "Object.Pool of unused InteractionData
", "access": "private", "kind": "member", "name": "interactionDataPool", "type": { "names": [ "Array.An event data object to handle all the event tracking/dispatching
", "kind": "member", "name": "eventData", "type": { "names": [ "object" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#eventData", "scope": "instance", "___id": "T000002R012653", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagereventData", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * The DOM element to bind to.\n *\n * @private\n * @member {HTMLElement} PIXI.interaction.InteractionManager#interactionDOMElement\n */", "meta": { "range": [ 4041, 4217 ], "filename": "InteractionManager.js", "lineno": 113, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "The DOM element to bind to.
", "access": "private", "kind": "member", "name": "interactionDOMElement", "type": { "names": [ "HTMLElement" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#interactionDOMElement", "scope": "instance", "___id": "T000002R012655", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerinteractionDOMElement", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * This property determines if mousemove and touchmove events are fired only when the cursor\n * is over the object.\n * Setting to true will make things work more in line with how the DOM verison works.\n * Setting to false can make things easier for things like dragging\n * It is currently set to false as this is how pixi used to work. This will be set to true in\n * future versions of pixi.\n *\n * @member {boolean} PIXI.interaction.InteractionManager#moveWhenInside\n * @default false\n */", "meta": { "range": [ 4270, 4842 ], "filename": "InteractionManager.js", "lineno": 121, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "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.
Have events been attached to the dom element?
", "access": "private", "kind": "member", "name": "eventsAdded", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#eventsAdded", "scope": "instance", "___id": "T000002R012659", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagereventsAdded", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Is the mouse hovering over the renderer?\n *\n * @private\n * @member {boolean} PIXI.interaction.InteractionManager#mouseOverRenderer\n */", "meta": { "range": [ 5113, 5294 ], "filename": "InteractionManager.js", "lineno": 142, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Is the mouse hovering over the renderer?
", "access": "private", "kind": "member", "name": "mouseOverRenderer", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#mouseOverRenderer", "scope": "instance", "___id": "T000002R012661", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagermouseOverRenderer", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Does the device support touch events\n * https://www.w3.org/TR/touch-events/\n *\n * @readonly\n * @member {boolean} PIXI.interaction.InteractionManager#supportsTouchEvents\n */", "meta": { "range": [ 5344, 5571 ], "filename": "InteractionManager.js", "lineno": 150, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Does the device support touch events
https://www.w3.org/TR/touch-events/
Does the device support pointer events
https://www.w3.org/Submission/pointer-events/
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.
The mode of the cursor that is being used.
The value of this is a key from the cursorStyles dictionary.
Internal cached let.
", "access": "private", "kind": "member", "name": "cursor", "type": { "names": [ "string" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#cursor", "scope": "instance", "___id": "T000002R012690", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagercursor", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Internal cached let.\n *\n * @private\n * @member {PIXI.Point} PIXI.interaction.InteractionManager#_tempPoint\n */", "meta": { "range": [ 8569, 8726 ], "filename": "InteractionManager.js", "lineno": 239, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Internal cached let.
", "access": "private", "kind": "member", "name": "_tempPoint", "type": { "names": [ "PIXI.Point" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#_tempPoint", "scope": "instance", "___id": "T000002R012692", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManager_tempPoint", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * The current resolution / device pixel ratio.\n *\n * @member {number} PIXI.interaction.InteractionManager#resolution\n * @default 1\n */", "meta": { "range": [ 8780, 8959 ], "filename": "InteractionManager.js", "lineno": 247, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "The current resolution / device pixel ratio.
", "kind": "member", "name": "resolution", "type": { "names": [ "number" ] }, "defaultvalue": "1", "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#resolution", "scope": "instance", "___id": "T000002R012694", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerresolution", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Fired when a pointer device button (usually a mouse left-button) is pressed on the display\n * object.\n *\n * @event mousedown\n * @type {PIXI.interaction.InteractionData}\n * @memberof PIXI.interaction.InteractionManager#\n */", "meta": { "range": [ 9076, 9361 ], "filename": "InteractionManager.js", "lineno": 257, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Fired when a pointer device button (usually a mouse left-button) is pressed 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 button (usually a mouse left-button) is released over 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 button (usually a mouse left-button) is pressed and released on
the display object.
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 button (usually a mouse left-button) is released outside the
display object that initially registered a
[mousedown]{@link PIXI.interaction.InteractionManager#event:mousedown}.
Fired when a pointer device secondary button (usually a mouse right-button) is released
outside the display object that initially registered a
[rightdown]{@link PIXI.interaction.InteractionManager#event:rightdown}.
Fired when a pointer device (usually a mouse) is moved while over the display object
", "kind": "event", "name": "mousemove", "type": { "names": [ "PIXI.interaction.InteractionData" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#event:mousemove", "scope": "instance", "___id": "T000002R012704", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerevent:mousemove", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Fired when a pointer device (usually a mouse) is moved onto the display object\n *\n * @event mouseover\n * @type {PIXI.interaction.InteractionData}\n * @memberof PIXI.interaction.InteractionManager#\n */", "meta": { "range": [ 12017, 12271 ], "filename": "InteractionManager.js", "lineno": 339, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Fired when a pointer device (usually a mouse) is moved onto the display object
", "kind": "event", "name": "mouseover", "type": { "names": [ "PIXI.interaction.InteractionData" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#event:mouseover", "scope": "instance", "___id": "T000002R012705", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerevent:mouseover", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Fired when a pointer device (usually a mouse) is moved off the display object\n *\n * @event mouseout\n * @type {PIXI.interaction.InteractionData}\n * @memberof PIXI.interaction.InteractionManager#\n */", "meta": { "range": [ 12281, 12533 ], "filename": "InteractionManager.js", "lineno": 347, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Fired when a pointer device (usually a mouse) is moved off the display object
", "kind": "event", "name": "mouseout", "type": { "names": [ "PIXI.interaction.InteractionData" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#event:mouseout", "scope": "instance", "___id": "T000002R012706", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerevent:mouseout", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Fired when a pointer device button is pressed on the display object.\n *\n * @event pointerdown\n * @type {PIXI.interaction.InteractionData}\n * @memberof PIXI.interaction.InteractionManager#\n */", "meta": { "range": [ 12543, 12789 ], "filename": "InteractionManager.js", "lineno": 355, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Fired when a pointer device button is pressed on the display object.
", "kind": "event", "name": "pointerdown", "type": { "names": [ "PIXI.interaction.InteractionData" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#event:pointerdown", "scope": "instance", "___id": "T000002R012707", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerevent:pointerdown", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Fired when a pointer device button is released over the display object.\n *\n * @event pointerup\n * @type {PIXI.interaction.InteractionData}\n * @memberof PIXI.interaction.InteractionManager#\n */", "meta": { "range": [ 12799, 13046 ], "filename": "InteractionManager.js", "lineno": 363, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Fired when a pointer device button is released over the display object.
", "kind": "event", "name": "pointerup", "type": { "names": [ "PIXI.interaction.InteractionData" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#event:pointerup", "scope": "instance", "___id": "T000002R012708", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerevent:pointerup", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Fired when the operating system cancels a pointer event\n *\n * @event pointercancel\n * @memberof PIXI.interaction.InteractionManager#\n */", "meta": { "range": [ 13056, 13239 ], "filename": "InteractionManager.js", "lineno": 371, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Fired when the operating system cancels a pointer event
", "kind": "event", "name": "pointercancel", "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#event:pointercancel", "scope": "instance", "___id": "T000002R012709", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerevent:pointercancel", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Fired when a pointer device button is pressed and released on the display object.\n *\n * @event pointertap\n * @type {PIXI.interaction.InteractionData}\n * @memberof PIXI.interaction.InteractionManager#\n */", "meta": { "range": [ 13249, 13507 ], "filename": "InteractionManager.js", "lineno": 378, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Fired when a pointer device button is pressed and released on the display object.
", "kind": "event", "name": "pointertap", "type": { "names": [ "PIXI.interaction.InteractionData" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#event:pointertap", "scope": "instance", "___id": "T000002R012710", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerevent:pointertap", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Fired when a pointer device button is released outside the display object that initially\n * registered a [pointerdown]{@link PIXI.interaction.InteractionManager#event:pointerdown}.\n *\n * @event pointerupoutside\n * @type {PIXI.interaction.InteractionData}\n * @memberof PIXI.interaction.InteractionManager#\n */", "meta": { "range": [ 13517, 13888 ], "filename": "InteractionManager.js", "lineno": 386, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Fired when a pointer device button is released outside the display object that initially
registered a [pointerdown]{@link PIXI.interaction.InteractionManager#event:pointerdown}.
Fired when a pointer device is moved while over the display object
", "kind": "event", "name": "pointermove", "type": { "names": [ "PIXI.interaction.InteractionData" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#event:pointermove", "scope": "instance", "___id": "T000002R012712", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerevent:pointermove", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Fired when a pointer device is moved onto the display object\n *\n * @event pointerover\n * @type {PIXI.interaction.InteractionData}\n * @memberof PIXI.interaction.InteractionManager#\n */", "meta": { "range": [ 14152, 14390 ], "filename": "InteractionManager.js", "lineno": 403, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Fired when a pointer device is moved onto the display object
", "kind": "event", "name": "pointerover", "type": { "names": [ "PIXI.interaction.InteractionData" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#event:pointerover", "scope": "instance", "___id": "T000002R012713", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerevent:pointerover", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Fired when a pointer device is moved off the display object\n *\n * @event pointerout\n * @type {PIXI.interaction.InteractionData}\n * @memberof PIXI.interaction.InteractionManager#\n */", "meta": { "range": [ 14400, 14636 ], "filename": "InteractionManager.js", "lineno": 411, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Fired when a pointer device is moved off the display object
", "kind": "event", "name": "pointerout", "type": { "names": [ "PIXI.interaction.InteractionData" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#event:pointerout", "scope": "instance", "___id": "T000002R012714", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerevent:pointerout", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Fired when a touch point is placed on the display object.\n *\n * @event touchstart\n * @type {PIXI.interaction.InteractionData}\n * @memberof PIXI.interaction.InteractionManager#\n */", "meta": { "range": [ 14646, 14880 ], "filename": "InteractionManager.js", "lineno": 419, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Fired when a touch point is placed on the display object.
", "kind": "event", "name": "touchstart", "type": { "names": [ "PIXI.interaction.InteractionData" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#event:touchstart", "scope": "instance", "___id": "T000002R012715", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerevent:touchstart", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Fired when a touch point is removed from the display object.\n *\n * @event touchend\n * @type {PIXI.interaction.InteractionData}\n * @memberof PIXI.interaction.InteractionManager#\n */", "meta": { "range": [ 14890, 15125 ], "filename": "InteractionManager.js", "lineno": 427, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Fired when a touch point is removed from the display object.
", "kind": "event", "name": "touchend", "type": { "names": [ "PIXI.interaction.InteractionData" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#event:touchend", "scope": "instance", "___id": "T000002R012716", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerevent:touchend", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Fired when the operating system cancels a touch\n *\n * @event touchcancel\n * @memberof PIXI.interaction.InteractionManager#\n */", "meta": { "range": [ 15135, 15308 ], "filename": "InteractionManager.js", "lineno": 435, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Fired when the operating system cancels a touch
", "kind": "event", "name": "touchcancel", "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#event:touchcancel", "scope": "instance", "___id": "T000002R012717", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerevent:touchcancel", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Fired when a touch point is placed and removed from the display object.\n *\n * @event tap\n * @type {PIXI.interaction.InteractionData}\n * @memberof PIXI.interaction.InteractionManager#\n */", "meta": { "range": [ 15318, 15559 ], "filename": "InteractionManager.js", "lineno": 442, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Fired when a touch point is placed and removed from the display object.
", "kind": "event", "name": "tap", "type": { "names": [ "PIXI.interaction.InteractionData" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#event:tap", "scope": "instance", "___id": "T000002R012718", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerevent:tap", "filepath": "interaction\\InteractionManager.js" }, { "comment": "/**\n * Fired when a touch point is removed outside of the display object that initially\n * registered a [touchstart]{@link PIXI.interaction.InteractionManager#event:touchstart}.\n *\n * @event touchendoutside\n * @type {PIXI.interaction.InteractionData}\n * @memberof PIXI.interaction.InteractionManager#\n */", "meta": { "range": [ 15569, 15929 ], "filename": "InteractionManager.js", "lineno": 450, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "Fired when a touch point is removed outside of the display object that initially
registered a [touchstart]{@link PIXI.interaction.InteractionManager#event:touchstart}.
Fired when a touch point is moved along the display object.
", "kind": "event", "name": "touchmove", "type": { "names": [ "PIXI.interaction.InteractionData" ] }, "memberof": "PIXI.interaction.InteractionManager", "longname": "PIXI.interaction.InteractionManager#event:touchmove", "scope": "instance", "___id": "T000002R012720", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionManagerevent:touchmove", "filepath": "interaction\\InteractionManager.js" } ], "$staticmethods": [], "$staticproperties": [], "$augments": [ { "name": "EventEmitter" } ], "$augmentedBy": [], "filepath": "interaction\\InteractionManager.js" }