Holds all information related to an Interaction event
| Public methods | |
|---|---|
| public | getLocalPosition(displayObject: PIXI.DisplayObject, point: PIXI.Point, globalPos: PIXI.Point): PIXI.Point |
| public | getLocalPosition(displayObject: PIXI.DisplayObject, point: PIXI.Point, globalPos: PIXI.Point): PIXI.Point |
| Name | Type | Attribute | Description |
|---|---|---|---|
| global | PIXI.Point | public | This point stores the global coords of where the touch/mouse event happened |
| target | PIXI.DisplayObject | public | The target DisplayObject that was interacted with |
| originalEvent | Event | public | When passed to an event handler, this will be the original DOM Event that was captured |
| identifier | number | public | Unique identifier for this interaction |
| global | PIXI.Point | public | This point stores the global coords of where the touch/mouse event happened |
| target | PIXI.DisplayObject | public | The target DisplayObject that was interacted with |
| originalEvent | Event | public | When passed to an event handler, this will be the original DOM Event that was captured |
| identifier | number | public | Unique identifier for this interaction |
This will return the local coordinates of the specified displayObject for this InteractionData
| Name | Type | Attribute | Description |
|---|---|---|---|
| displayObject | The DisplayObject that you would like the local |
||
| point | A Point object in which to store the value, optional (otherwise |
||
| globalPos | A Point object containing your custom global coords, optional |
PIXI.Point
This will return the local coordinates of the specified displayObject for this InteractionData
| Name | Type | Attribute | Description |
|---|---|---|---|
| displayObject | The DisplayObject that you would like the local |
||
| point | A Point object in which to store the value, optional (otherwise |
||
| globalPos | A Point object containing your custom global coords, optional |
PIXI.Point
{
"comment": "/**\n * Holds all information related to an Interaction event\n *\n * @class\n * @memberof PIXI.interaction\n */",
"meta": {
"range": [
175,
1951
],
"filename": "InteractionData.js",
"lineno": 11,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction",
"code": {
"id": "astnode100060831",
"name": "InteractionData",
"type": "ClassDeclaration",
"paramnames": []
}
},
"classdesc": "Holds all information related to an Interaction event
",
"kind": "class",
"memberof": "PIXI.interaction",
"name": "InteractionData",
"longname": "PIXI.interaction.InteractionData",
"scope": "static",
"params": [],
"___id": "T000002R005668",
"___s": true,
"$methods": [
{
"comment": "/**\n * This will return the local coordinates of the specified displayObject for this InteractionData\n *\n * @param {PIXI.DisplayObject} displayObject - The DisplayObject that you would like the local\n * coords off\n * @param {PIXI.Point} [point] - A Point object in which to store the value, optional (otherwise\n * will create a new point)\n * @param {PIXI.Point} [globalPos] - A Point object containing your custom global coords, optional\n * (otherwise will use the current global coords)\n * @return {PIXI.Point} A point containing the coordinates of the InteractionData position relative\n * to the DisplayObject\n */",
"meta": {
"range": [
1797,
1949
],
"filename": "InteractionData.js",
"lineno": 59,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction",
"code": {
"id": "astnode100060865",
"name": "InteractionData#getLocalPosition",
"type": "MethodDefinition",
"paramnames": [
"displayObject",
"point",
"globalPos"
]
},
"vars": {
"": null
}
},
"description": "This will return the local coordinates of the specified displayObject for this InteractionData
",
"params": [
{
"type": {
"names": [
"PIXI.DisplayObject"
]
},
"description": "The DisplayObject that you would like the local
coords off
",
"name": "displayObject"
},
{
"type": {
"names": [
"PIXI.Point"
]
},
"optional": true,
"description": "A Point object in which to store the value, optional (otherwise
will create a new point)
",
"name": "point"
},
{
"type": {
"names": [
"PIXI.Point"
]
},
"optional": true,
"description": "A Point object containing your custom global coords, optional
(otherwise will use the current global coords)
",
"name": "globalPos"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Point"
]
},
"description": "A point containing the coordinates of the InteractionData position relative
to the DisplayObject
"
}
],
"name": "getLocalPosition",
"longname": "PIXI.interaction.InteractionData#getLocalPosition",
"kind": "function",
"memberof": "PIXI.interaction.InteractionData",
"scope": "instance",
"___id": "T000002R005678",
"___s": true,
"skip": true,
"slug": "PIXI.interaction.InteractionDatagetLocalPosition",
"filepath": "interaction\\InteractionData.js"
},
{
"comment": "/**\n * This will return the local coordinates of the specified displayObject for this InteractionData\n *\n * @param {PIXI.DisplayObject} displayObject - The DisplayObject that you would like the local\n * coords off\n * @param {PIXI.Point} [point] - A Point object in which to store the value, optional (otherwise\n * will create a new point)\n * @param {PIXI.Point} [globalPos] - A Point object containing your custom global coords, optional\n * (otherwise will use the current global coords)\n * @return {PIXI.Point} A point containing the coordinates of the InteractionData position relative\n * to the DisplayObject\n */",
"meta": {
"range": [
1797,
1949
],
"filename": "InteractionData.js",
"lineno": 59,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction",
"code": {
"id": "astnode100135544",
"name": "InteractionData#getLocalPosition",
"type": "MethodDefinition",
"paramnames": [
"displayObject",
"point",
"globalPos"
]
},
"vars": {
"": null
}
},
"description": "This will return the local coordinates of the specified displayObject for this InteractionData
",
"params": [
{
"type": {
"names": [
"PIXI.DisplayObject"
]
},
"description": "The DisplayObject that you would like the local
coords off
",
"name": "displayObject"
},
{
"type": {
"names": [
"PIXI.Point"
]
},
"optional": true,
"description": "A Point object in which to store the value, optional (otherwise
will create a new point)
",
"name": "point"
},
{
"type": {
"names": [
"PIXI.Point"
]
},
"optional": true,
"description": "A Point object containing your custom global coords, optional
(otherwise will use the current global coords)
",
"name": "globalPos"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Point"
]
},
"description": "A point containing the coordinates of the InteractionData position relative
to the DisplayObject
"
}
],
"name": "getLocalPosition",
"longname": "PIXI.interaction.InteractionData#getLocalPosition",
"kind": "function",
"memberof": "PIXI.interaction.InteractionData",
"scope": "instance",
"___id": "T000002R012612",
"___s": true,
"skip": true,
"slug": "PIXI.interaction.InteractionDatagetLocalPosition",
"filepath": "interaction\\InteractionData.js"
}
],
"$attributes": [
{
"comment": "/**\n * This point stores the global coords of where the touch/mouse event happened\n *\n * @member {PIXI.Point} PIXI.interaction.InteractionData#global\n */",
"meta": {
"range": [
254,
439
],
"filename": "InteractionData.js",
"lineno": 18,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction",
"code": {}
},
"description": "This point stores the global coords of where the touch/mouse event happened
",
"kind": "member",
"name": "global",
"type": {
"names": [
"PIXI.Point"
]
},
"memberof": "PIXI.interaction.InteractionData",
"longname": "PIXI.interaction.InteractionData#global",
"scope": "instance",
"___id": "T000002R005670",
"___s": true,
"skip": true,
"slug": "PIXI.interaction.InteractionDataglobal",
"filepath": "interaction\\InteractionData.js"
},
{
"comment": "/**\n * The target DisplayObject that was interacted with\n *\n * @member {PIXI.DisplayObject} PIXI.interaction.InteractionData#target\n */",
"meta": {
"range": [
489,
656
],
"filename": "InteractionData.js",
"lineno": 25,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction",
"code": {}
},
"description": "The target DisplayObject that was interacted with
",
"kind": "member",
"name": "target",
"type": {
"names": [
"PIXI.DisplayObject"
]
},
"memberof": "PIXI.interaction.InteractionData",
"longname": "PIXI.interaction.InteractionData#target",
"scope": "instance",
"___id": "T000002R005672",
"___s": true,
"skip": true,
"slug": "PIXI.interaction.InteractionDatatarget",
"filepath": "interaction\\InteractionData.js"
},
{
"comment": "/**\n * When passed to an event handler, this will be the original DOM Event that was captured\n *\n * @member {Event} PIXI.interaction.InteractionData#originalEvent\n */",
"meta": {
"range": [
694,
892
],
"filename": "InteractionData.js",
"lineno": 32,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction",
"code": {}
},
"description": "When passed to an event handler, this will be the original DOM Event that was captured
",
"kind": "member",
"name": "originalEvent",
"type": {
"names": [
"Event"
]
},
"memberof": "PIXI.interaction.InteractionData",
"longname": "PIXI.interaction.InteractionData#originalEvent",
"scope": "instance",
"___id": "T000002R005674",
"___s": true,
"skip": true,
"slug": "PIXI.interaction.InteractionDataoriginalEvent",
"filepath": "interaction\\InteractionData.js"
},
{
"comment": "/**\n * Unique identifier for this interaction\n *\n * @member {number} PIXI.interaction.InteractionData#identifier\n */",
"meta": {
"range": [
937,
1085
],
"filename": "InteractionData.js",
"lineno": 39,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction",
"code": {}
},
"description": "Unique identifier for this interaction
",
"kind": "member",
"name": "identifier",
"type": {
"names": [
"number"
]
},
"memberof": "PIXI.interaction.InteractionData",
"longname": "PIXI.interaction.InteractionData#identifier",
"scope": "instance",
"___id": "T000002R005676",
"___s": true,
"skip": true,
"slug": "PIXI.interaction.InteractionDataidentifier",
"filepath": "interaction\\InteractionData.js"
},
{
"comment": "/**\n * This point stores the global coords of where the touch/mouse event happened\n *\n * @member {PIXI.Point} PIXI.interaction.InteractionData#global\n */",
"meta": {
"range": [
254,
439
],
"filename": "InteractionData.js",
"lineno": 18,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction",
"code": {}
},
"description": "This point stores the global coords of where the touch/mouse event happened
",
"kind": "member",
"name": "global",
"type": {
"names": [
"PIXI.Point"
]
},
"memberof": "PIXI.interaction.InteractionData",
"longname": "PIXI.interaction.InteractionData#global",
"scope": "instance",
"___id": "T000002R012604",
"___s": true,
"skip": true,
"slug": "PIXI.interaction.InteractionDataglobal",
"filepath": "interaction\\InteractionData.js"
},
{
"comment": "/**\n * The target DisplayObject that was interacted with\n *\n * @member {PIXI.DisplayObject} PIXI.interaction.InteractionData#target\n */",
"meta": {
"range": [
489,
656
],
"filename": "InteractionData.js",
"lineno": 25,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction",
"code": {}
},
"description": "The target DisplayObject that was interacted with
",
"kind": "member",
"name": "target",
"type": {
"names": [
"PIXI.DisplayObject"
]
},
"memberof": "PIXI.interaction.InteractionData",
"longname": "PIXI.interaction.InteractionData#target",
"scope": "instance",
"___id": "T000002R012606",
"___s": true,
"skip": true,
"slug": "PIXI.interaction.InteractionDatatarget",
"filepath": "interaction\\InteractionData.js"
},
{
"comment": "/**\n * When passed to an event handler, this will be the original DOM Event that was captured\n *\n * @member {Event} PIXI.interaction.InteractionData#originalEvent\n */",
"meta": {
"range": [
694,
892
],
"filename": "InteractionData.js",
"lineno": 32,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction",
"code": {}
},
"description": "When passed to an event handler, this will be the original DOM Event that was captured
",
"kind": "member",
"name": "originalEvent",
"type": {
"names": [
"Event"
]
},
"memberof": "PIXI.interaction.InteractionData",
"longname": "PIXI.interaction.InteractionData#originalEvent",
"scope": "instance",
"___id": "T000002R012608",
"___s": true,
"skip": true,
"slug": "PIXI.interaction.InteractionDataoriginalEvent",
"filepath": "interaction\\InteractionData.js"
},
{
"comment": "/**\n * Unique identifier for this interaction\n *\n * @member {number} PIXI.interaction.InteractionData#identifier\n */",
"meta": {
"range": [
937,
1085
],
"filename": "InteractionData.js",
"lineno": 39,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction",
"code": {}
},
"description": "Unique identifier for this interaction
",
"kind": "member",
"name": "identifier",
"type": {
"names": [
"number"
]
},
"memberof": "PIXI.interaction.InteractionData",
"longname": "PIXI.interaction.InteractionData#identifier",
"scope": "instance",
"___id": "T000002R012610",
"___s": true,
"skip": true,
"slug": "PIXI.interaction.InteractionDataidentifier",
"filepath": "interaction\\InteractionData.js"
}
],
"$staticmethods": [],
"$staticproperties": [],
"$augments": [],
"$augmentedBy": [],
"filepath": "interaction\\InteractionData.js"
}