DisplayObjects with the {@link PIXI.interaction.interactiveTarget} mixin use this class to track interactions
| Public methods | |
|---|---|
| private | _doSet(flag: number, yn: boolean): void |
| public | pointerId(): void |
| public | flags(flags: number): void |
| public | over(yn: boolean): void |
| public | rightDown(yn: boolean): void |
| public | leftDown(yn: boolean): void |
| private | _doSet(flag: number, yn: boolean): void |
| public | pointerId(): void |
| public | flags(flags: number): void |
| public | over(yn: boolean): void |
| public | rightDown(yn: boolean): void |
| public | leftDown(yn: boolean): void |
| Name | Type | Attribute | Description |
|---|---|---|---|
| flag | The interaction flag to set |
||
| yn | Should the flag be set or unset |
void
Unique pointer id of the event
void
Set the flags for the tracking data
| Name | Type | Attribute | Description |
|---|---|---|---|
| flags | Flags to set |
void
Set the over flag
| Name | Type | Attribute | Description |
|---|---|---|---|
| yn | Is the event over? |
void
Set the right down flag
| Name | Type | Attribute | Description |
|---|---|---|---|
| yn | Is the right mouse button down? |
void
Set the left down flag
| Name | Type | Attribute | Description |
|---|---|---|---|
| yn | Is the left mouse button down? |
void
| Name | Type | Attribute | Description |
|---|---|---|---|
| flag | The interaction flag to set |
||
| yn | Should the flag be set or unset |
void
Unique pointer id of the event
void
Set the flags for the tracking data
| Name | Type | Attribute | Description |
|---|---|---|---|
| flags | Flags to set |
void
Set the over flag
| Name | Type | Attribute | Description |
|---|---|---|---|
| yn | Is the event over? |
void
Set the right down flag
| Name | Type | Attribute | Description |
|---|---|---|---|
| yn | Is the right mouse button down? |
void
Set the left down flag
| Name | Type | Attribute | Description |
|---|---|---|---|
| yn | Is the left mouse button down? |
void
{
"comment": "/**\n * DisplayObjects with the {@link PIXI.interaction.interactiveTarget} mixin use this class to track interactions\n *\n * @class\n * @private\n * @memberof PIXI.interaction\n */",
"meta": {
"range": [
217,
3036
],
"filename": "InteractionTrackingData.js",
"lineno": 10,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction",
"code": {
"id": "astnode100064703",
"name": "InteractionTrackingData",
"type": "ClassDeclaration",
"paramnames": [
"pointerId"
]
}
},
"classdesc": "DisplayObjects with the {@link PIXI.interaction.interactiveTarget} mixin use this class to track interactions
",
"kind": "class",
"access": "private",
"memberof": "PIXI.interaction",
"name": "InteractionTrackingData",
"longname": "PIXI.interaction.InteractionTrackingData",
"scope": "static",
"params": [
{
"type": {
"names": [
"number"
]
},
"description": "Unique pointer id of the event
",
"name": "pointerId"
}
],
"___id": "T000002R005994",
"___s": true,
"$methods": [
{
"comment": "/**\n *\n * @private\n * @param {number} flag - The interaction flag to set\n * @param {boolean} yn - Should the flag be set or unset\n */",
"meta": {
"range": [
628,
820
],
"filename": "InteractionTrackingData.js",
"lineno": 27,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction",
"code": {
"id": "astnode100064727",
"name": "InteractionTrackingData#_doSet",
"type": "MethodDefinition",
"paramnames": [
"flag",
"yn"
]
},
"vars": {
"": null
}
},
"access": "private",
"params": [
{
"type": {
"names": [
"number"
]
},
"description": "The interaction flag to set
",
"name": "flag"
},
{
"type": {
"names": [
"boolean"
]
},
"description": "Should the flag be set or unset
",
"name": "yn"
}
],
"name": "_doSet",
"longname": "PIXI.interaction.InteractionTrackingData#_doSet",
"kind": "function",
"memberof": "PIXI.interaction.InteractionTrackingData",
"scope": "instance",
"___id": "T000002R005998",
"___s": true,
"skip": true,
"slug": "PIXI.interaction.InteractionTrackingData_doSet",
"filepath": "interaction\\InteractionTrackingData.js"
},
{
"comment": "/**\n * Unique pointer id of the event\n *\n * @readonly\n * @member {number}\n */",
"meta": {
"range": [
928,
987
],
"filename": "InteractionTrackingData.js",
"lineno": 45,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction",
"code": {
"id": "astnode100064758",
"name": "InteractionTrackingData#pointerId",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Unique pointer id of the event
",
"readonly": true,
"kind": "member",
"type": {
"names": [
"number"
]
},
"name": "pointerId",
"longname": "PIXI.interaction.InteractionTrackingData#pointerId",
"memberof": "PIXI.interaction.InteractionTrackingData",
"scope": "instance",
"params": [],
"___id": "T000002R006001",
"___s": true,
"skip": true,
"slug": "PIXI.interaction.InteractionTrackingDatapointerId",
"filepath": "interaction\\InteractionTrackingData.js"
},
{
"comment": "/**\n * Set the flags for the tracking data\n *\n * @param {number} flags - Flags to set\n */",
"meta": {
"range": [
1324,
1381
],
"filename": "InteractionTrackingData.js",
"lineno": 66,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction",
"code": {
"id": "astnode100064774",
"name": "InteractionTrackingData#flags",
"type": "MethodDefinition",
"paramnames": [
"flags"
]
},
"vars": {
"": null
}
},
"description": "Set the flags for the tracking data
",
"params": [
{
"type": {
"names": [
"number"
]
},
"description": "Flags to set
",
"name": "flags"
}
],
"name": "flags",
"longname": "PIXI.interaction.InteractionTrackingData#flags",
"kind": "member",
"memberof": "PIXI.interaction.InteractionTrackingData",
"scope": "instance",
"___id": "T000002R006003",
"___s": true,
"skip": true,
"slug": "PIXI.interaction.InteractionTrackingDataflags",
"filepath": "interaction\\InteractionTrackingData.js"
},
{
"comment": "/**\n * Set the over flag\n *\n * @param {boolean} yn - Is the event over?\n */",
"meta": {
"range": [
1987,
2065
],
"filename": "InteractionTrackingData.js",
"lineno": 98,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction",
"code": {
"id": "astnode100064819",
"name": "InteractionTrackingData#over",
"type": "MethodDefinition",
"paramnames": [
"yn"
]
},
"vars": {
"": null
}
},
"description": "Set the over flag
",
"params": [
{
"type": {
"names": [
"boolean"
]
},
"description": "Is the event over?
",
"name": "yn"
}
],
"name": "over",
"longname": "PIXI.interaction.InteractionTrackingData#over",
"kind": "member",
"memberof": "PIXI.interaction.InteractionTrackingData",
"scope": "instance",
"___id": "T000002R006007",
"___s": true,
"skip": true,
"slug": "PIXI.interaction.InteractionTrackingDataover",
"filepath": "interaction\\InteractionTrackingData.js"
},
{
"comment": "/**\n * Set the right down flag\n *\n * @param {boolean} yn - Is the right mouse button down?\n */",
"meta": {
"range": [
2464,
2553
],
"filename": "InteractionTrackingData.js",
"lineno": 119,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction",
"code": {
"id": "astnode100064855",
"name": "InteractionTrackingData#rightDown",
"type": "MethodDefinition",
"paramnames": [
"yn"
]
},
"vars": {
"": null
}
},
"description": "Set the right down flag
",
"params": [
{
"type": {
"names": [
"boolean"
]
},
"description": "Is the right mouse button down?
",
"name": "yn"
}
],
"name": "rightDown",
"longname": "PIXI.interaction.InteractionTrackingData#rightDown",
"kind": "member",
"memberof": "PIXI.interaction.InteractionTrackingData",
"scope": "instance",
"___id": "T000002R006009",
"___s": true,
"skip": true,
"slug": "PIXI.interaction.InteractionTrackingDatarightDown",
"filepath": "interaction\\InteractionTrackingData.js"
},
{
"comment": "/**\n * Set the left down flag\n *\n * @param {boolean} yn - Is the left mouse button down?\n */",
"meta": {
"range": [
2947,
3034
],
"filename": "InteractionTrackingData.js",
"lineno": 140,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction",
"code": {
"id": "astnode100064891",
"name": "InteractionTrackingData#leftDown",
"type": "MethodDefinition",
"paramnames": [
"yn"
]
},
"vars": {
"": null
}
},
"description": "Set the left down flag
",
"params": [
{
"type": {
"names": [
"boolean"
]
},
"description": "Is the left mouse button down?
",
"name": "yn"
}
],
"name": "leftDown",
"longname": "PIXI.interaction.InteractionTrackingData#leftDown",
"kind": "member",
"memberof": "PIXI.interaction.InteractionTrackingData",
"scope": "instance",
"___id": "T000002R006011",
"___s": true,
"skip": true,
"slug": "PIXI.interaction.InteractionTrackingDataleftDown",
"filepath": "interaction\\InteractionTrackingData.js"
},
{
"comment": "/**\n *\n * @private\n * @param {number} flag - The interaction flag to set\n * @param {boolean} yn - Should the flag be set or unset\n */",
"meta": {
"range": [
628,
820
],
"filename": "InteractionTrackingData.js",
"lineno": 27,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction",
"code": {
"id": "astnode100139406",
"name": "InteractionTrackingData#_doSet",
"type": "MethodDefinition",
"paramnames": [
"flag",
"yn"
]
},
"vars": {
"": null
}
},
"access": "private",
"params": [
{
"type": {
"names": [
"number"
]
},
"description": "The interaction flag to set
",
"name": "flag"
},
{
"type": {
"names": [
"boolean"
]
},
"description": "Should the flag be set or unset
",
"name": "yn"
}
],
"name": "_doSet",
"longname": "PIXI.interaction.InteractionTrackingData#_doSet",
"kind": "function",
"memberof": "PIXI.interaction.InteractionTrackingData",
"scope": "instance",
"___id": "T000002R012932",
"___s": true,
"skip": true,
"slug": "PIXI.interaction.InteractionTrackingData_doSet",
"filepath": "interaction\\InteractionTrackingData.js"
},
{
"comment": "/**\n * Unique pointer id of the event\n *\n * @readonly\n * @member {number}\n */",
"meta": {
"range": [
928,
987
],
"filename": "InteractionTrackingData.js",
"lineno": 45,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction",
"code": {
"id": "astnode100139437",
"name": "InteractionTrackingData#pointerId",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Unique pointer id of the event
",
"readonly": true,
"kind": "member",
"type": {
"names": [
"number"
]
},
"name": "pointerId",
"longname": "PIXI.interaction.InteractionTrackingData#pointerId",
"memberof": "PIXI.interaction.InteractionTrackingData",
"scope": "instance",
"params": [],
"___id": "T000002R012935",
"___s": true,
"skip": true,
"slug": "PIXI.interaction.InteractionTrackingDatapointerId",
"filepath": "interaction\\InteractionTrackingData.js"
},
{
"comment": "/**\n * Set the flags for the tracking data\n *\n * @param {number} flags - Flags to set\n */",
"meta": {
"range": [
1324,
1381
],
"filename": "InteractionTrackingData.js",
"lineno": 66,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction",
"code": {
"id": "astnode100139453",
"name": "InteractionTrackingData#flags",
"type": "MethodDefinition",
"paramnames": [
"flags"
]
},
"vars": {
"": null
}
},
"description": "Set the flags for the tracking data
",
"params": [
{
"type": {
"names": [
"number"
]
},
"description": "Flags to set
",
"name": "flags"
}
],
"name": "flags",
"longname": "PIXI.interaction.InteractionTrackingData#flags",
"kind": "member",
"memberof": "PIXI.interaction.InteractionTrackingData",
"scope": "instance",
"___id": "T000002R012937",
"___s": true,
"skip": true,
"slug": "PIXI.interaction.InteractionTrackingDataflags",
"filepath": "interaction\\InteractionTrackingData.js"
},
{
"comment": "/**\n * Set the over flag\n *\n * @param {boolean} yn - Is the event over?\n */",
"meta": {
"range": [
1987,
2065
],
"filename": "InteractionTrackingData.js",
"lineno": 98,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction",
"code": {
"id": "astnode100139498",
"name": "InteractionTrackingData#over",
"type": "MethodDefinition",
"paramnames": [
"yn"
]
},
"vars": {
"": null
}
},
"description": "Set the over flag
",
"params": [
{
"type": {
"names": [
"boolean"
]
},
"description": "Is the event over?
",
"name": "yn"
}
],
"name": "over",
"longname": "PIXI.interaction.InteractionTrackingData#over",
"kind": "member",
"memberof": "PIXI.interaction.InteractionTrackingData",
"scope": "instance",
"___id": "T000002R012941",
"___s": true,
"skip": true,
"slug": "PIXI.interaction.InteractionTrackingDataover",
"filepath": "interaction\\InteractionTrackingData.js"
},
{
"comment": "/**\n * Set the right down flag\n *\n * @param {boolean} yn - Is the right mouse button down?\n */",
"meta": {
"range": [
2464,
2553
],
"filename": "InteractionTrackingData.js",
"lineno": 119,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction",
"code": {
"id": "astnode100139534",
"name": "InteractionTrackingData#rightDown",
"type": "MethodDefinition",
"paramnames": [
"yn"
]
},
"vars": {
"": null
}
},
"description": "Set the right down flag
",
"params": [
{
"type": {
"names": [
"boolean"
]
},
"description": "Is the right mouse button down?
",
"name": "yn"
}
],
"name": "rightDown",
"longname": "PIXI.interaction.InteractionTrackingData#rightDown",
"kind": "member",
"memberof": "PIXI.interaction.InteractionTrackingData",
"scope": "instance",
"___id": "T000002R012943",
"___s": true,
"skip": true,
"slug": "PIXI.interaction.InteractionTrackingDatarightDown",
"filepath": "interaction\\InteractionTrackingData.js"
},
{
"comment": "/**\n * Set the left down flag\n *\n * @param {boolean} yn - Is the left mouse button down?\n */",
"meta": {
"range": [
2947,
3034
],
"filename": "InteractionTrackingData.js",
"lineno": 140,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction",
"code": {
"id": "astnode100139570",
"name": "InteractionTrackingData#leftDown",
"type": "MethodDefinition",
"paramnames": [
"yn"
]
},
"vars": {
"": null
}
},
"description": "Set the left down flag
",
"params": [
{
"type": {
"names": [
"boolean"
]
},
"description": "Is the left mouse button down?
",
"name": "yn"
}
],
"name": "leftDown",
"longname": "PIXI.interaction.InteractionTrackingData#leftDown",
"kind": "member",
"memberof": "PIXI.interaction.InteractionTrackingData",
"scope": "instance",
"___id": "T000002R012945",
"___s": true,
"skip": true,
"slug": "PIXI.interaction.InteractionTrackingDataleftDown",
"filepath": "interaction\\InteractionTrackingData.js"
}
],
"$attributes": [],
"$staticmethods": [],
"$staticproperties": [],
"$augments": [],
"$augmentedBy": [],
"filepath": "interaction\\InteractionTrackingData.js"
}