Generic class to deal with traditional 2D matrix transforms
| Public methods | |
|---|---|
| public | updateLocalTransform(): void |
| public | updateTransform(parentTransform: PIXI.TransformBase): void |
| public | updateLocalTransform(): void |
| public | updateTransform(parentTransform: PIXI.TransformBase): void |
| Name | Type | Attribute | Description |
|---|---|---|---|
| worldTransform | PIXI.Matrix | public | The global matrix transform. It can be swapped temporarily by some functions like getLocalBounds() |
| localTransform | PIXI.Matrix | public | The local matrix transform |
| updateWorldTransform | public | Updates the values of the object and applies the parent's transform. |
|
| worldTransform | PIXI.Matrix | public | The global matrix transform. It can be swapped temporarily by some functions like getLocalBounds() |
| localTransform | PIXI.Matrix | public | The local matrix transform |
| updateWorldTransform | public | Updates the values of the object and applies the parent's transform. |
TransformBase does not have decomposition, so this function wont do anything
void
Updates the values of the object and applies the parent's transform.
| Name | Type | Attribute | Description |
|---|---|---|---|
| parentTransform | The transform of the parent of this object |
void
TransformBase does not have decomposition, so this function wont do anything
void
Updates the values of the object and applies the parent's transform.
| Name | Type | Attribute | Description |
|---|---|---|---|
| parentTransform | The transform of the parent of this object |
void
{
"comment": "/**\n * Generic class to deal with traditional 2D matrix transforms\n *\n * @class\n * @memberof PIXI\n */",
"meta": {
"range": [
168,
1665
],
"filename": "TransformBase.js",
"lineno": 11,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display",
"code": {
"id": "astnode100006626",
"name": "TransformBase",
"type": "ClassDeclaration",
"paramnames": []
}
},
"classdesc": "Generic class to deal with traditional 2D matrix transforms
",
"kind": "class",
"memberof": "PIXI",
"name": "TransformBase",
"longname": "PIXI.TransformBase",
"scope": "static",
"params": [],
"___id": "T000002R000677",
"___s": true,
"$methods": [
{
"comment": "/**\n * TransformBase does not have decomposition, so this function wont do anything\n */",
"meta": {
"range": [
845,
896
],
"filename": "TransformBase.js",
"lineno": 39,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display",
"code": {
"id": "astnode100006659",
"name": "TransformBase#updateLocalTransform",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "TransformBase does not have decomposition, so this function wont do anything
",
"name": "updateLocalTransform",
"longname": "PIXI.TransformBase#updateLocalTransform",
"kind": "function",
"memberof": "PIXI.TransformBase",
"scope": "instance",
"params": [],
"___id": "T000002R000685",
"___s": true,
"skip": true,
"slug": "PIXI.TransformBaseupdateLocalTransform",
"filepath": "core\\display\\TransformBase.js"
},
{
"comment": "/**\n * Updates the values of the object and applies the parent's transform.\n *\n * @param {PIXI.TransformBase} parentTransform - The transform of the parent of this object\n */",
"meta": {
"range": [
1097,
1662
],
"filename": "TransformBase.js",
"lineno": 49,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display",
"code": {
"id": "astnode100006663",
"name": "TransformBase#updateTransform",
"type": "MethodDefinition",
"paramnames": [
"parentTransform"
]
},
"vars": {
"": null
}
},
"description": "Updates the values of the object and applies the parent's transform.
",
"params": [
{
"type": {
"names": [
"PIXI.TransformBase"
]
},
"description": "The transform of the parent of this object
",
"name": "parentTransform"
}
],
"name": "updateTransform",
"longname": "PIXI.TransformBase#updateTransform",
"kind": "function",
"memberof": "PIXI.TransformBase",
"scope": "instance",
"___id": "T000002R000686",
"___s": true,
"skip": true,
"slug": "PIXI.TransformBaseupdateTransform",
"filepath": "core\\display\\TransformBase.js"
},
{
"comment": "/**\n * TransformBase does not have decomposition, so this function wont do anything\n */",
"meta": {
"range": [
845,
896
],
"filename": "TransformBase.js",
"lineno": 39,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display",
"code": {
"id": "astnode100081338",
"name": "TransformBase#updateLocalTransform",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "TransformBase does not have decomposition, so this function wont do anything
",
"name": "updateLocalTransform",
"longname": "PIXI.TransformBase#updateLocalTransform",
"kind": "function",
"memberof": "PIXI.TransformBase",
"scope": "instance",
"params": [],
"___id": "T000002R007619",
"___s": true,
"skip": true,
"slug": "PIXI.TransformBaseupdateLocalTransform",
"filepath": "core\\display\\TransformBase.js"
},
{
"comment": "/**\n * Updates the values of the object and applies the parent's transform.\n *\n * @param {PIXI.TransformBase} parentTransform - The transform of the parent of this object\n */",
"meta": {
"range": [
1097,
1662
],
"filename": "TransformBase.js",
"lineno": 49,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display",
"code": {
"id": "astnode100081342",
"name": "TransformBase#updateTransform",
"type": "MethodDefinition",
"paramnames": [
"parentTransform"
]
},
"vars": {
"": null
}
},
"description": "Updates the values of the object and applies the parent's transform.
",
"params": [
{
"type": {
"names": [
"PIXI.TransformBase"
]
},
"description": "The transform of the parent of this object
",
"name": "parentTransform"
}
],
"name": "updateTransform",
"longname": "PIXI.TransformBase#updateTransform",
"kind": "function",
"memberof": "PIXI.TransformBase",
"scope": "instance",
"___id": "T000002R007620",
"___s": true,
"skip": true,
"slug": "PIXI.TransformBaseupdateTransform",
"filepath": "core\\display\\TransformBase.js"
}
],
"$attributes": [
{
"comment": "/**\n * The global matrix transform. It can be swapped temporarily by some functions like getLocalBounds()\n *\n * @member {PIXI.Matrix} PIXI.TransformBase#worldTransform\n */",
"meta": {
"range": [
245,
448
],
"filename": "TransformBase.js",
"lineno": 18,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display",
"code": {}
},
"description": "The global matrix transform. It can be swapped temporarily by some functions like getLocalBounds()
",
"kind": "member",
"name": "worldTransform",
"type": {
"names": [
"PIXI.Matrix"
]
},
"memberof": "PIXI.TransformBase",
"longname": "PIXI.TransformBase#worldTransform",
"scope": "instance",
"___id": "T000002R000679",
"___s": true,
"skip": true,
"slug": "PIXI.TransformBaseworldTransform",
"filepath": "core\\display\\TransformBase.js"
},
{
"comment": "/**\n * The local matrix transform\n *\n * @member {PIXI.Matrix} PIXI.TransformBase#localTransform\n */",
"meta": {
"range": [
502,
633
],
"filename": "TransformBase.js",
"lineno": 25,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display",
"code": {}
},
"description": "The local matrix transform
",
"kind": "member",
"name": "localTransform",
"type": {
"names": [
"PIXI.Matrix"
]
},
"memberof": "PIXI.TransformBase",
"longname": "PIXI.TransformBase#localTransform",
"scope": "instance",
"___id": "T000002R000681",
"___s": true,
"skip": true,
"slug": "PIXI.TransformBaselocalTransform",
"filepath": "core\\display\\TransformBase.js"
},
{
"comment": "/**\n * Updates the values of the object and applies the parent's transform.\n * @param parentTransform {PIXI.Transform} The transform of the parent of this object\n *\n */",
"meta": {
"range": [
1837,
1923
],
"filename": "TransformBase.js",
"lineno": 73,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display",
"code": {
"id": "astnode100006820",
"name": "TransformBase.prototype.updateWorldTransform",
"type": "MemberExpression",
"value": "TransformBase.prototype.updateTransform",
"paramnames": []
}
},
"description": "Updates the values of the object and applies the parent's transform.
",
"params": [
{
"type": {
"names": [
"PIXI.Transform"
]
},
"description": "The transform of the parent of this object
",
"name": "parentTransform"
}
],
"name": "updateWorldTransform",
"longname": "PIXI.TransformBase#updateWorldTransform",
"kind": "member",
"memberof": "PIXI.TransformBase",
"scope": "instance",
"___id": "T000002R000696",
"___s": true,
"skip": true,
"slug": "PIXI.TransformBaseupdateWorldTransform",
"filepath": "core\\display\\TransformBase.js"
},
{
"comment": "/**\n * The global matrix transform. It can be swapped temporarily by some functions like getLocalBounds()\n *\n * @member {PIXI.Matrix} PIXI.TransformBase#worldTransform\n */",
"meta": {
"range": [
245,
448
],
"filename": "TransformBase.js",
"lineno": 18,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display",
"code": {}
},
"description": "The global matrix transform. It can be swapped temporarily by some functions like getLocalBounds()
",
"kind": "member",
"name": "worldTransform",
"type": {
"names": [
"PIXI.Matrix"
]
},
"memberof": "PIXI.TransformBase",
"longname": "PIXI.TransformBase#worldTransform",
"scope": "instance",
"___id": "T000002R007613",
"___s": true,
"skip": true,
"slug": "PIXI.TransformBaseworldTransform",
"filepath": "core\\display\\TransformBase.js"
},
{
"comment": "/**\n * The local matrix transform\n *\n * @member {PIXI.Matrix} PIXI.TransformBase#localTransform\n */",
"meta": {
"range": [
502,
633
],
"filename": "TransformBase.js",
"lineno": 25,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display",
"code": {}
},
"description": "The local matrix transform
",
"kind": "member",
"name": "localTransform",
"type": {
"names": [
"PIXI.Matrix"
]
},
"memberof": "PIXI.TransformBase",
"longname": "PIXI.TransformBase#localTransform",
"scope": "instance",
"___id": "T000002R007615",
"___s": true,
"skip": true,
"slug": "PIXI.TransformBaselocalTransform",
"filepath": "core\\display\\TransformBase.js"
},
{
"comment": "/**\n * Updates the values of the object and applies the parent's transform.\n * @param parentTransform {PIXI.Transform} The transform of the parent of this object\n *\n */",
"meta": {
"range": [
1837,
1923
],
"filename": "TransformBase.js",
"lineno": 73,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display",
"code": {
"id": "astnode100081499",
"name": "TransformBase.prototype.updateWorldTransform",
"type": "MemberExpression",
"value": "TransformBase.prototype.updateTransform",
"paramnames": []
}
},
"description": "Updates the values of the object and applies the parent's transform.
",
"params": [
{
"type": {
"names": [
"PIXI.Transform"
]
},
"description": "The transform of the parent of this object
",
"name": "parentTransform"
}
],
"name": "updateWorldTransform",
"longname": "PIXI.TransformBase#updateWorldTransform",
"kind": "member",
"memberof": "PIXI.TransformBase",
"scope": "instance",
"___id": "T000002R007630",
"___s": true,
"skip": true,
"slug": "PIXI.TransformBaseupdateWorldTransform",
"filepath": "core\\display\\TransformBase.js"
}
],
"$staticmethods": [],
"$staticproperties": [],
"$augments": [],
"$augmentedBy": [
{
"name": "Transform"
},
{
"name": "TransformStatic"
},
{
"name": "Transform"
},
{
"name": "TransformStatic"
}
],
"filepath": "core\\display\\TransformBase.js"
}