class: Matrix
The pixi Matrix class as an object, which makes it a lot faster,
Methods summary
Public methods
public
fromArray (array: Array .<number >): void
public
set (a: number , b: number , c: number , d: number , tx: number , ty: number ): PIXI.Matrix
public
toArray (transpose: boolean , out: Float32Array ): Array .<number >
public
apply (pos: PIXI.Point, newPos: PIXI.Point): PIXI.Point
public
applyInverse (pos: PIXI.Point, newPos: PIXI.Point): PIXI.Point
public
translate (x: number , y: number ): PIXI.Matrix
public
scale (x: number , y: number ): PIXI.Matrix
public
rotate (angle: number ): PIXI.Matrix
public
append (matrix: PIXI.Matrix): PIXI.Matrix
public
setTransform (x: number , y: number , pivotX: number , pivotY: number , scaleX: number , scaleY: number , rotation: number , skewX: number , skewY: number ): PIXI.Matrix
public
prepend (matrix: PIXI.Matrix): PIXI.Matrix
public
decompose (transform: PIXI.Transform, PIXI.TransformStatic): PIXI.Transform, PIXI.TransformStatic
public
invert (): PIXI.Matrix
public
identity (): PIXI.Matrix
public
clone (): PIXI.Matrix
public
copy (matrix: PIXI.Matrix): PIXI.Matrix
public
static
IDENTITY (): void
public
static
TEMP_MATRIX (): void
public
fromArray (array: Array .<number >): void
public
set (a: number , b: number , c: number , d: number , tx: number , ty: number ): PIXI.Matrix
public
toArray (transpose: boolean , out: Float32Array ): Array .<number >
public
apply (pos: PIXI.Point, newPos: PIXI.Point): PIXI.Point
public
applyInverse (pos: PIXI.Point, newPos: PIXI.Point): PIXI.Point
public
translate (x: number , y: number ): PIXI.Matrix
public
scale (x: number , y: number ): PIXI.Matrix
public
rotate (angle: number ): PIXI.Matrix
public
append (matrix: PIXI.Matrix): PIXI.Matrix
public
setTransform (x: number , y: number , pivotX: number , pivotY: number , scaleX: number , scaleY: number , rotation: number , skewX: number , skewY: number ): PIXI.Matrix
public
prepend (matrix: PIXI.Matrix): PIXI.Matrix
public
decompose (transform: PIXI.Transform, PIXI.TransformStatic): PIXI.Transform, PIXI.TransformStatic
public
invert (): PIXI.Matrix
public
identity (): PIXI.Matrix
public
clone (): PIXI.Matrix
public
copy (matrix: PIXI.Matrix): PIXI.Matrix
public
static
IDENTITY (): void
public
static
TEMP_MATRIX (): void
Properties
Methods
fromArray (array: Array .<number >): void
Creates a Matrix object based on the given array. The Element to Matrix mapping order is as follows:
a = array[0]
Params:
Name
Type
Attribute
Description
array
The array that the matrix will be populated from.
Returns:
void
sets the matrix properties
Params:
Name
Type
Attribute
Description
a
Matrix component
b
Matrix component
c
Matrix component
d
Matrix component
tx
Matrix component
ty
Matrix component
Returns:
PIXI.Matrix
Creates an array from the current Matrix object.
Params:
Name
Type
Attribute
Description
transpose
Whether we need to transpose the matrix or not
out
If provided the array will be assigned to out
Returns:
Array .<number >
apply (pos: PIXI.Point, newPos: PIXI.Point): PIXI.Point
Get a new position with the current transformation applied.
Params:
Name
Type
Attribute
Description
pos
The origin
newPos
The point that the new position is assigned to (allowed to be same as input)
Returns:
PIXI.Point
applyInverse (pos: PIXI.Point, newPos: PIXI.Point): PIXI.Point
Get a new position with the inverse of the current transformation applied.
Params:
Name
Type
Attribute
Description
pos
The origin
newPos
The point that the new position is assigned to (allowed to be same as input)
Returns:
PIXI.Point
translate (x: number , y: number ): PIXI.Matrix
Translates the matrix on the x and y.
Params:
Name
Type
Attribute
Description
x
How much to translate x by
y
How much to translate y by
Returns:
PIXI.Matrix
scale (x: number , y: number ): PIXI.Matrix
Applies a scale transformation to the matrix.
Params:
Name
Type
Attribute
Description
x
The amount to scale horizontally
y
The amount to scale vertically
Returns:
PIXI.Matrix
rotate (angle: number ): PIXI.Matrix
Applies a rotation transformation to the matrix.
Params:
Name
Type
Attribute
Description
angle
The angle in radians.
Returns:
PIXI.Matrix
append (matrix: PIXI.Matrix): PIXI.Matrix
Appends the given Matrix to this Matrix.
Params:
Name
Type
Attribute
Description
matrix
The matrix to append.
Returns:
PIXI.Matrix
Sets the matrix based on all the available properties
Params:
Name
Type
Attribute
Description
x
Position on the x axis
y
Position on the y axis
pivotX
Pivot on the x axis
pivotY
Pivot on the y axis
scaleX
Scale on the x axis
scaleY
Scale on the y axis
rotation
Rotation in radians
skewX
Skew on the x axis
skewY
Skew on the y axis
Returns:
PIXI.Matrix
prepend (matrix: PIXI.Matrix): PIXI.Matrix
Prepends the given Matrix to this Matrix.
Params:
Name
Type
Attribute
Description
matrix
The matrix to prepend
Returns:
PIXI.Matrix
decompose (transform: PIXI.Transform, PIXI.TransformStatic): PIXI.Transform, PIXI.TransformStatic
Decomposes the matrix (x, y, scaleX, scaleY, and rotation) and sets the properties on to a transform.
Params:
Name
Type
Attribute
Description
transform
The transform to apply the properties to.
Returns:
PIXI.Transform, PIXI.TransformStatic
invert (): PIXI.Matrix
Inverts this matrix
Returns:
PIXI.Matrix
identity (): PIXI.Matrix
Resets this Matix to an identity (default) matrix.
Returns:
PIXI.Matrix
clone (): PIXI.Matrix
Creates a new Matrix object with the same values as this one.
Returns:
PIXI.Matrix
copy (matrix: PIXI.Matrix): PIXI.Matrix
Changes the values of the given matrix to be the same as the ones in this matrix
Params:
Name
Type
Attribute
Description
matrix
The matrix to copy from.
Returns:
PIXI.Matrix
IDENTITY (): void
A default (identity) matrix
Returns:
void
TEMP_MATRIX (): void
A temp matrix
Returns:
void
fromArray (array: Array .<number >): void
Creates a Matrix object based on the given array. The Element to Matrix mapping order is as follows:
a = array[0]
Params:
Name
Type
Attribute
Description
array
The array that the matrix will be populated from.
Returns:
void
sets the matrix properties
Params:
Name
Type
Attribute
Description
a
Matrix component
b
Matrix component
c
Matrix component
d
Matrix component
tx
Matrix component
ty
Matrix component
Returns:
PIXI.Matrix
Creates an array from the current Matrix object.
Params:
Name
Type
Attribute
Description
transpose
Whether we need to transpose the matrix or not
out
If provided the array will be assigned to out
Returns:
Array .<number >
apply (pos: PIXI.Point, newPos: PIXI.Point): PIXI.Point
Get a new position with the current transformation applied.
Params:
Name
Type
Attribute
Description
pos
The origin
newPos
The point that the new position is assigned to (allowed to be same as input)
Returns:
PIXI.Point
applyInverse (pos: PIXI.Point, newPos: PIXI.Point): PIXI.Point
Get a new position with the inverse of the current transformation applied.
Params:
Name
Type
Attribute
Description
pos
The origin
newPos
The point that the new position is assigned to (allowed to be same as input)
Returns:
PIXI.Point
translate (x: number , y: number ): PIXI.Matrix
Translates the matrix on the x and y.
Params:
Name
Type
Attribute
Description
x
How much to translate x by
y
How much to translate y by
Returns:
PIXI.Matrix
scale (x: number , y: number ): PIXI.Matrix
Applies a scale transformation to the matrix.
Params:
Name
Type
Attribute
Description
x
The amount to scale horizontally
y
The amount to scale vertically
Returns:
PIXI.Matrix
rotate (angle: number ): PIXI.Matrix
Applies a rotation transformation to the matrix.
Params:
Name
Type
Attribute
Description
angle
The angle in radians.
Returns:
PIXI.Matrix
append (matrix: PIXI.Matrix): PIXI.Matrix
Appends the given Matrix to this Matrix.
Params:
Name
Type
Attribute
Description
matrix
The matrix to append.
Returns:
PIXI.Matrix
Sets the matrix based on all the available properties
Params:
Name
Type
Attribute
Description
x
Position on the x axis
y
Position on the y axis
pivotX
Pivot on the x axis
pivotY
Pivot on the y axis
scaleX
Scale on the x axis
scaleY
Scale on the y axis
rotation
Rotation in radians
skewX
Skew on the x axis
skewY
Skew on the y axis
Returns:
PIXI.Matrix
prepend (matrix: PIXI.Matrix): PIXI.Matrix
Prepends the given Matrix to this Matrix.
Params:
Name
Type
Attribute
Description
matrix
The matrix to prepend
Returns:
PIXI.Matrix
decompose (transform: PIXI.Transform, PIXI.TransformStatic): PIXI.Transform, PIXI.TransformStatic
Decomposes the matrix (x, y, scaleX, scaleY, and rotation) and sets the properties on to a transform.
Params:
Name
Type
Attribute
Description
transform
The transform to apply the properties to.
Returns:
PIXI.Transform, PIXI.TransformStatic
invert (): PIXI.Matrix
Inverts this matrix
Returns:
PIXI.Matrix
identity (): PIXI.Matrix
Resets this Matix to an identity (default) matrix.
Returns:
PIXI.Matrix
clone (): PIXI.Matrix
Creates a new Matrix object with the same values as this one.
Returns:
PIXI.Matrix
copy (matrix: PIXI.Matrix): PIXI.Matrix
Changes the values of the given matrix to be the same as the ones in this matrix
Params:
Name
Type
Attribute
Description
matrix
The matrix to copy from.
Returns:
PIXI.Matrix
IDENTITY (): void
A default (identity) matrix
Returns:
void
TEMP_MATRIX (): void
A temp matrix
Returns:
void
DEBUG BUTTON NOT FOR PRODUCTION : toggle JSDoc record visibility
{
"comment": "/**\n * The pixi Matrix class as an object, which makes it a lot faster,\n * here is a representation of it :\n * | a | b | tx|\n * | c | d | ty|\n * | 0 | 0 | 1 |\n *\n * @class\n * @memberof PIXI\n */",
"meta": {
"range": [
248,
12956
],
"filename": "Matrix.js",
"lineno": 15,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100017162",
"name": "Matrix",
"type": "ClassDeclaration",
"paramnames": [
"a",
"b",
"c",
"d",
"tx",
"ty"
]
}
},
"classdesc": "The pixi Matrix class as an object, which makes it a lot faster,
",
"kind": "class",
"memberof": "PIXI",
"name": "Matrix",
"longname": "PIXI.Matrix",
"scope": "static",
"params": [
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": 1,
"description": "x scale
",
"name": "a"
},
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": 0,
"description": "y skew
",
"name": "b"
},
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": 0,
"description": "x skew
",
"name": "c"
},
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": 1,
"description": "y scale
",
"name": "d"
},
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": 0,
"description": "x translation
",
"name": "tx"
},
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": 0,
"description": "y translation
",
"name": "ty"
}
],
"___id": "T000002R001600",
"___s": true,
"$methods": [
{
"comment": "/**\n * Creates a Matrix object based on the given array. The Element to Matrix mapping order is as follows:\n *\n * a = array[0]\n * b = array[1]\n * c = array[3]\n * d = array[4]\n * tx = array[2]\n * ty = array[5]\n *\n * @param {number[]} array - The array that the matrix will be populated from.\n */",
"meta": {
"range": [
1632,
1824
],
"filename": "Matrix.js",
"lineno": 78,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100017229",
"name": "Matrix#fromArray",
"type": "MethodDefinition",
"paramnames": [
"array"
]
},
"vars": {
"": null
}
},
"description": "Creates a Matrix object based on the given array. The Element to Matrix mapping order is as follows:
\na = array[0]
",
"params": [
{
"type": {
"names": [
"Array."
]
},
"description": "The array that the matrix will be populated from.
",
"name": "array"
}
],
"name": "fromArray",
"longname": "PIXI.Matrix#fromArray",
"kind": "function",
"memberof": "PIXI.Matrix",
"scope": "instance",
"___id": "T000002R001615",
"___s": true,
"skip": true,
"slug": "PIXI.MatrixfromArray",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * sets the matrix properties\n *\n * @param {number} a - Matrix component\n * @param {number} b - Matrix component\n * @param {number} c - Matrix component\n * @param {number} d - Matrix component\n * @param {number} tx - Matrix component\n * @param {number} ty - Matrix component\n *\n * @return {PIXI.Matrix} This matrix. Good for chaining method calls.\n */",
"meta": {
"range": [
2234,
2415
],
"filename": "Matrix.js",
"lineno": 100,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100017282",
"name": "Matrix#set",
"type": "MethodDefinition",
"paramnames": [
"a",
"b",
"c",
"d",
"tx",
"ty"
]
},
"vars": {
"": null
}
},
"description": "sets the matrix properties
",
"params": [
{
"type": {
"names": [
"number"
]
},
"description": "Matrix component
",
"name": "a"
},
{
"type": {
"names": [
"number"
]
},
"description": "Matrix component
",
"name": "b"
},
{
"type": {
"names": [
"number"
]
},
"description": "Matrix component
",
"name": "c"
},
{
"type": {
"names": [
"number"
]
},
"description": "Matrix component
",
"name": "d"
},
{
"type": {
"names": [
"number"
]
},
"description": "Matrix component
",
"name": "tx"
},
{
"type": {
"names": [
"number"
]
},
"description": "Matrix component
",
"name": "ty"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Matrix"
]
},
"description": "This matrix. Good for chaining method calls.
"
}
],
"name": "set",
"longname": "PIXI.Matrix#set",
"kind": "function",
"memberof": "PIXI.Matrix",
"scope": "instance",
"___id": "T000002R001622",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixset",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * Creates an array from the current Matrix object.\n *\n * @param {boolean} transpose - Whether we need to transpose the matrix or not\n * @param {Float32Array} [out=new Float32Array(9)] - If provided the array will be assigned to out\n * @return {number[]} the newly created array which contains the matrix\n */",
"meta": {
"range": [
2762,
3562
],
"filename": "Matrix.js",
"lineno": 119,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100017330",
"name": "Matrix#toArray",
"type": "MethodDefinition",
"paramnames": [
"transpose",
"out"
]
},
"vars": {
"": null
}
},
"description": "Creates an array from the current Matrix object.
",
"params": [
{
"type": {
"names": [
"boolean"
]
},
"description": "Whether we need to transpose the matrix or not
",
"name": "transpose"
},
{
"type": {
"names": [
"Float32Array"
]
},
"optional": true,
"defaultvalue": "new Float32Array(9)",
"description": "If provided the array will be assigned to out
",
"name": "out"
}
],
"returns": [
{
"type": {
"names": [
"Array."
]
},
"description": "the newly created array which contains the matrix
"
}
],
"name": "toArray",
"longname": "PIXI.Matrix#toArray",
"kind": "function",
"memberof": "PIXI.Matrix",
"scope": "instance",
"___id": "T000002R001629",
"___s": true,
"skip": true,
"slug": "PIXI.MatrixtoArray",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * Get a new position with the current transformation applied.\n * Can be used to go from a child's coordinate space to the world coordinate space. (e.g. rendering)\n *\n * @param {PIXI.Point} pos - The origin\n * @param {PIXI.Point} [newPos] - The point that the new position is assigned to (allowed to be same as input)\n * @return {PIXI.Point} The new point, transformed through this matrix\n */",
"meta": {
"range": [
3997,
4259
],
"filename": "Matrix.js",
"lineno": 164,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100017496",
"name": "Matrix#apply",
"type": "MethodDefinition",
"paramnames": [
"pos",
"newPos"
]
},
"vars": {
"": null
}
},
"description": "Get a new position with the current transformation applied.
",
"params": [
{
"type": {
"names": [
"PIXI.Point"
]
},
"description": "The origin
",
"name": "pos"
},
{
"type": {
"names": [
"PIXI.Point"
]
},
"optional": true,
"description": "The point that the new position is assigned to (allowed to be same as input)
",
"name": "newPos"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Point"
]
},
"description": "The new point, transformed through this matrix
"
}
],
"name": "apply",
"longname": "PIXI.Matrix#apply",
"kind": "function",
"memberof": "PIXI.Matrix",
"scope": "instance",
"___id": "T000002R001650",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixapply",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * Get a new position with the inverse of the current transformation applied.\n * Can be used to go from the world coordinate space to a child's coordinate space. (e.g. input)\n *\n * @param {PIXI.Point} pos - The origin\n * @param {PIXI.Point} [newPos] - The point that the new position is assigned to (allowed to be same as input)\n * @return {PIXI.Point} The new point, inverse-transformed through this matrix\n */",
"meta": {
"range": [
4713,
5153
],
"filename": "Matrix.js",
"lineno": 185,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100017563",
"name": "Matrix#applyInverse",
"type": "MethodDefinition",
"paramnames": [
"pos",
"newPos"
]
},
"vars": {
"": null
}
},
"description": "Get a new position with the inverse of the current transformation applied.
",
"params": [
{
"type": {
"names": [
"PIXI.Point"
]
},
"description": "The origin
",
"name": "pos"
},
{
"type": {
"names": [
"PIXI.Point"
]
},
"optional": true,
"description": "The point that the new position is assigned to (allowed to be same as input)
",
"name": "newPos"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Point"
]
},
"description": "The new point, inverse-transformed through this matrix
"
}
],
"name": "applyInverse",
"longname": "PIXI.Matrix#applyInverse",
"kind": "function",
"memberof": "PIXI.Matrix",
"scope": "instance",
"___id": "T000002R001656",
"___s": true,
"skip": true,
"slug": "PIXI.MatrixapplyInverse",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * Translates the matrix on the x and y.\n *\n * @param {number} x How much to translate x by\n * @param {number} y How much to translate y by\n * @return {PIXI.Matrix} This matrix. Good for chaining method calls.\n */",
"meta": {
"range": [
5405,
5498
],
"filename": "Matrix.js",
"lineno": 207,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100017690",
"name": "Matrix#translate",
"type": "MethodDefinition",
"paramnames": [
"x",
"y"
]
},
"vars": {
"": null
}
},
"description": "Translates the matrix on the x and y.
",
"params": [
{
"type": {
"names": [
"number"
]
},
"description": "How much to translate x by
",
"name": "x"
},
{
"type": {
"names": [
"number"
]
},
"description": "How much to translate y by
",
"name": "y"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Matrix"
]
},
"description": "This matrix. Good for chaining method calls.
"
}
],
"name": "translate",
"longname": "PIXI.Matrix#translate",
"kind": "function",
"memberof": "PIXI.Matrix",
"scope": "instance",
"___id": "T000002R001663",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixtranslate",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * Applies a scale transformation to the matrix.\n *\n * @param {number} x The amount to scale horizontally\n * @param {number} y The amount to scale vertically\n * @return {PIXI.Matrix} This matrix. Good for chaining method calls.\n */",
"meta": {
"range": [
5768,
5941
],
"filename": "Matrix.js",
"lineno": 222,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100017710",
"name": "Matrix#scale",
"type": "MethodDefinition",
"paramnames": [
"x",
"y"
]
},
"vars": {
"": null
}
},
"description": "Applies a scale transformation to the matrix.
",
"params": [
{
"type": {
"names": [
"number"
]
},
"description": "The amount to scale horizontally
",
"name": "x"
},
{
"type": {
"names": [
"number"
]
},
"description": "The amount to scale vertically
",
"name": "y"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Matrix"
]
},
"description": "This matrix. Good for chaining method calls.
"
}
],
"name": "scale",
"longname": "PIXI.Matrix#scale",
"kind": "function",
"memberof": "PIXI.Matrix",
"scope": "instance",
"___id": "T000002R001666",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixscale",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * Applies a rotation transformation to the matrix.\n *\n * @param {number} angle - The angle in radians.\n * @return {PIXI.Matrix} This matrix. Good for chaining method calls.\n */",
"meta": {
"range": [
6153,
6641
],
"filename": "Matrix.js",
"lineno": 240,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100017754",
"name": "Matrix#rotate",
"type": "MethodDefinition",
"paramnames": [
"angle"
]
},
"vars": {
"": null
}
},
"description": "Applies a rotation transformation to the matrix.
",
"params": [
{
"type": {
"names": [
"number"
]
},
"description": "The angle in radians.
",
"name": "angle"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Matrix"
]
},
"description": "This matrix. Good for chaining method calls.
"
}
],
"name": "rotate",
"longname": "PIXI.Matrix#rotate",
"kind": "function",
"memberof": "PIXI.Matrix",
"scope": "instance",
"___id": "T000002R001673",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixrotate",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * Appends the given Matrix to this Matrix.\n *\n * @param {PIXI.Matrix} matrix - The matrix to append.\n * @return {PIXI.Matrix} This matrix. Good for chaining method calls.\n */",
"meta": {
"range": [
6851,
7347
],
"filename": "Matrix.js",
"lineno": 265,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100017879",
"name": "Matrix#append",
"type": "MethodDefinition",
"paramnames": [
"matrix"
]
},
"vars": {
"": null
}
},
"description": "Appends the given Matrix to this Matrix.
",
"params": [
{
"type": {
"names": [
"PIXI.Matrix"
]
},
"description": "The matrix to append.
",
"name": "matrix"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Matrix"
]
},
"description": "This matrix. Good for chaining method calls.
"
}
],
"name": "append",
"longname": "PIXI.Matrix#append",
"kind": "function",
"memberof": "PIXI.Matrix",
"scope": "instance",
"___id": "T000002R001685",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixappend",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * Sets the matrix based on all the available properties\n *\n * @param {number} x - Position on the x axis\n * @param {number} y - Position on the y axis\n * @param {number} pivotX - Pivot on the x axis\n * @param {number} pivotY - Pivot on the y axis\n * @param {number} scaleX - Scale on the x axis\n * @param {number} scaleY - Scale on the y axis\n * @param {number} rotation - Rotation in radians\n * @param {number} skewX - Skew on the x axis\n * @param {number} skewY - Skew on the y axis\n * @return {PIXI.Matrix} This matrix. Good for chaining method calls.\n */",
"meta": {
"range": [
7973,
8693
],
"filename": "Matrix.js",
"lineno": 297,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100018014",
"name": "Matrix#setTransform",
"type": "MethodDefinition",
"paramnames": [
"x",
"y",
"pivotX",
"pivotY",
"scaleX",
"scaleY",
"rotation",
"skewX",
"skewY"
]
},
"vars": {
"": null
}
},
"description": "Sets the matrix based on all the available properties
",
"params": [
{
"type": {
"names": [
"number"
]
},
"description": "Position on the x axis
",
"name": "x"
},
{
"type": {
"names": [
"number"
]
},
"description": "Position on the y axis
",
"name": "y"
},
{
"type": {
"names": [
"number"
]
},
"description": "Pivot on the x axis
",
"name": "pivotX"
},
{
"type": {
"names": [
"number"
]
},
"description": "Pivot on the y axis
",
"name": "pivotY"
},
{
"type": {
"names": [
"number"
]
},
"description": "Scale on the x axis
",
"name": "scaleX"
},
{
"type": {
"names": [
"number"
]
},
"description": "Scale on the y axis
",
"name": "scaleY"
},
{
"type": {
"names": [
"number"
]
},
"description": "Rotation in radians
",
"name": "rotation"
},
{
"type": {
"names": [
"number"
]
},
"description": "Skew on the x axis
",
"name": "skewX"
},
{
"type": {
"names": [
"number"
]
},
"description": "Skew on the y axis
",
"name": "skewY"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Matrix"
]
},
"description": "This matrix. Good for chaining method calls.
"
}
],
"name": "setTransform",
"longname": "PIXI.Matrix#setTransform",
"kind": "function",
"memberof": "PIXI.Matrix",
"scope": "instance",
"___id": "T000002R001696",
"___s": true,
"skip": true,
"slug": "PIXI.MatrixsetTransform",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * Prepends the given Matrix to this Matrix.\n *\n * @param {PIXI.Matrix} matrix - The matrix to prepend\n * @return {PIXI.Matrix} This matrix. Good for chaining method calls.\n */",
"meta": {
"range": [
8904,
9531
],
"filename": "Matrix.js",
"lineno": 328,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100018179",
"name": "Matrix#prepend",
"type": "MethodDefinition",
"paramnames": [
"matrix"
]
},
"vars": {
"": null
}
},
"description": "Prepends the given Matrix to this Matrix.
",
"params": [
{
"type": {
"names": [
"PIXI.Matrix"
]
},
"description": "The matrix to prepend
",
"name": "matrix"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Matrix"
]
},
"description": "This matrix. Good for chaining method calls.
"
}
],
"name": "prepend",
"longname": "PIXI.Matrix#prepend",
"kind": "function",
"memberof": "PIXI.Matrix",
"scope": "instance",
"___id": "T000002R001713",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixprepend",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * Decomposes the matrix (x, y, scaleX, scaleY, and rotation) and sets the properties on to a transform.\n *\n * @param {PIXI.Transform|PIXI.TransformStatic} transform - The transform to apply the properties to.\n * @return {PIXI.Transform|PIXI.TransformStatic} The transform with the newly applied properties\n */",
"meta": {
"range": [
9876,
10862
],
"filename": "Matrix.js",
"lineno": 355,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100018345",
"name": "Matrix#decompose",
"type": "MethodDefinition",
"paramnames": [
"transform"
]
},
"vars": {
"": null
}
},
"description": "Decomposes the matrix (x, y, scaleX, scaleY, and rotation) and sets the properties on to a transform.
",
"params": [
{
"type": {
"names": [
"PIXI.Transform",
"PIXI.TransformStatic"
]
},
"description": "The transform to apply the properties to.
",
"name": "transform"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Transform",
"PIXI.TransformStatic"
]
},
"description": "The transform with the newly applied properties
"
}
],
"name": "decompose",
"longname": "PIXI.Matrix#decompose",
"kind": "function",
"memberof": "PIXI.Matrix",
"scope": "instance",
"___id": "T000002R001723",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixdecompose",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * Inverts this matrix\n *\n * @return {PIXI.Matrix} This matrix. Good for chaining method calls.\n */",
"meta": {
"range": [
10992,
11422
],
"filename": "Matrix.js",
"lineno": 401,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100018531",
"name": "Matrix#invert",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Inverts this matrix
",
"returns": [
{
"type": {
"names": [
"PIXI.Matrix"
]
},
"description": "This matrix. Good for chaining method calls.
"
}
],
"name": "invert",
"longname": "PIXI.Matrix#invert",
"kind": "function",
"memberof": "PIXI.Matrix",
"scope": "instance",
"params": [],
"___id": "T000002R001741",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixinvert",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * Resets this Matix to an identity (default) matrix.\n *\n * @return {PIXI.Matrix} This matrix. Good for chaining method calls.\n */",
"meta": {
"range": [
11583,
11749
],
"filename": "Matrix.js",
"lineno": 425,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100018644",
"name": "Matrix#identity",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Resets this Matix to an identity (default) matrix.
",
"returns": [
{
"type": {
"names": [
"PIXI.Matrix"
]
},
"description": "This matrix. Good for chaining method calls.
"
}
],
"name": "identity",
"longname": "PIXI.Matrix#identity",
"kind": "function",
"memberof": "PIXI.Matrix",
"scope": "instance",
"params": [],
"___id": "T000002R001754",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixidentity",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * Creates a new Matrix object with the same values as this one.\n *\n * @return {PIXI.Matrix} A copy of this matrix. Good for chaining method calls.\n */",
"meta": {
"range": [
11931,
12178
],
"filename": "Matrix.js",
"lineno": 442,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100018686",
"name": "Matrix#clone",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Creates a new Matrix object with the same values as this one.
",
"returns": [
{
"type": {
"names": [
"PIXI.Matrix"
]
},
"description": "A copy of this matrix. Good for chaining method calls.
"
}
],
"name": "clone",
"longname": "PIXI.Matrix#clone",
"kind": "function",
"memberof": "PIXI.Matrix",
"scope": "instance",
"params": [],
"___id": "T000002R001761",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixclone",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * Changes the values of the given matrix to be the same as the ones in this matrix\n *\n * @param {PIXI.Matrix} matrix - The matrix to copy from.\n * @return {PIXI.Matrix} The matrix given in parameter with its values updated.\n */",
"meta": {
"range": [
12441,
12655
],
"filename": "Matrix.js",
"lineno": 462,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100018745",
"name": "Matrix#copy",
"type": "MethodDefinition",
"paramnames": [
"matrix"
]
},
"vars": {
"": null
}
},
"description": "Changes the values of the given matrix to be the same as the ones in this matrix
",
"params": [
{
"type": {
"names": [
"PIXI.Matrix"
]
},
"description": "The matrix to copy from.
",
"name": "matrix"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Matrix"
]
},
"description": "The matrix given in parameter with its values updated.
"
}
],
"name": "copy",
"longname": "PIXI.Matrix#copy",
"kind": "function",
"memberof": "PIXI.Matrix",
"scope": "instance",
"___id": "T000002R001769",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixcopy",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * A default (identity) matrix\n *\n * @static\n * @const\n */",
"meta": {
"range": [
12748,
12810
],
"filename": "Matrix.js",
"lineno": 480,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100018800",
"name": "Matrix.IDENTITY",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "A default (identity) matrix
",
"scope": "static",
"kind": "constant",
"name": "IDENTITY",
"longname": "PIXI.Matrix.IDENTITY",
"memberof": "PIXI.Matrix",
"params": [],
"___id": "T000002R001776",
"___s": true,
"skip": true,
"slug": "PIXI.Matrix.IDENTITY",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * A temp matrix\n *\n * @static\n * @const\n */",
"meta": {
"range": [
12889,
12954
],
"filename": "Matrix.js",
"lineno": 491,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100018807",
"name": "Matrix.TEMP_MATRIX",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "A temp matrix
",
"scope": "static",
"kind": "constant",
"name": "TEMP_MATRIX",
"longname": "PIXI.Matrix.TEMP_MATRIX",
"memberof": "PIXI.Matrix",
"params": [],
"___id": "T000002R001777",
"___s": true,
"skip": true,
"slug": "PIXI.Matrix.TEMP_MATRIX",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * Creates a Matrix object based on the given array. The Element to Matrix mapping order is as follows:\n *\n * a = array[0]\n * b = array[1]\n * c = array[3]\n * d = array[4]\n * tx = array[2]\n * ty = array[5]\n *\n * @param {number[]} array - The array that the matrix will be populated from.\n */",
"meta": {
"range": [
1632,
1824
],
"filename": "Matrix.js",
"lineno": 78,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100091908",
"name": "Matrix#fromArray",
"type": "MethodDefinition",
"paramnames": [
"array"
]
},
"vars": {
"": null
}
},
"description": "Creates a Matrix object based on the given array. The Element to Matrix mapping order is as follows:
\na = array[0]
",
"params": [
{
"type": {
"names": [
"Array."
]
},
"description": "The array that the matrix will be populated from.
",
"name": "array"
}
],
"name": "fromArray",
"longname": "PIXI.Matrix#fromArray",
"kind": "function",
"memberof": "PIXI.Matrix",
"scope": "instance",
"___id": "T000002R008549",
"___s": true,
"skip": true,
"slug": "PIXI.MatrixfromArray",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * sets the matrix properties\n *\n * @param {number} a - Matrix component\n * @param {number} b - Matrix component\n * @param {number} c - Matrix component\n * @param {number} d - Matrix component\n * @param {number} tx - Matrix component\n * @param {number} ty - Matrix component\n *\n * @return {PIXI.Matrix} This matrix. Good for chaining method calls.\n */",
"meta": {
"range": [
2234,
2415
],
"filename": "Matrix.js",
"lineno": 100,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100091961",
"name": "Matrix#set",
"type": "MethodDefinition",
"paramnames": [
"a",
"b",
"c",
"d",
"tx",
"ty"
]
},
"vars": {
"": null
}
},
"description": "sets the matrix properties
",
"params": [
{
"type": {
"names": [
"number"
]
},
"description": "Matrix component
",
"name": "a"
},
{
"type": {
"names": [
"number"
]
},
"description": "Matrix component
",
"name": "b"
},
{
"type": {
"names": [
"number"
]
},
"description": "Matrix component
",
"name": "c"
},
{
"type": {
"names": [
"number"
]
},
"description": "Matrix component
",
"name": "d"
},
{
"type": {
"names": [
"number"
]
},
"description": "Matrix component
",
"name": "tx"
},
{
"type": {
"names": [
"number"
]
},
"description": "Matrix component
",
"name": "ty"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Matrix"
]
},
"description": "This matrix. Good for chaining method calls.
"
}
],
"name": "set",
"longname": "PIXI.Matrix#set",
"kind": "function",
"memberof": "PIXI.Matrix",
"scope": "instance",
"___id": "T000002R008556",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixset",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * Creates an array from the current Matrix object.\n *\n * @param {boolean} transpose - Whether we need to transpose the matrix or not\n * @param {Float32Array} [out=new Float32Array(9)] - If provided the array will be assigned to out\n * @return {number[]} the newly created array which contains the matrix\n */",
"meta": {
"range": [
2762,
3562
],
"filename": "Matrix.js",
"lineno": 119,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100092009",
"name": "Matrix#toArray",
"type": "MethodDefinition",
"paramnames": [
"transpose",
"out"
]
},
"vars": {
"": null
}
},
"description": "Creates an array from the current Matrix object.
",
"params": [
{
"type": {
"names": [
"boolean"
]
},
"description": "Whether we need to transpose the matrix or not
",
"name": "transpose"
},
{
"type": {
"names": [
"Float32Array"
]
},
"optional": true,
"defaultvalue": "new Float32Array(9)",
"description": "If provided the array will be assigned to out
",
"name": "out"
}
],
"returns": [
{
"type": {
"names": [
"Array."
]
},
"description": "the newly created array which contains the matrix
"
}
],
"name": "toArray",
"longname": "PIXI.Matrix#toArray",
"kind": "function",
"memberof": "PIXI.Matrix",
"scope": "instance",
"___id": "T000002R008563",
"___s": true,
"skip": true,
"slug": "PIXI.MatrixtoArray",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * Get a new position with the current transformation applied.\n * Can be used to go from a child's coordinate space to the world coordinate space. (e.g. rendering)\n *\n * @param {PIXI.Point} pos - The origin\n * @param {PIXI.Point} [newPos] - The point that the new position is assigned to (allowed to be same as input)\n * @return {PIXI.Point} The new point, transformed through this matrix\n */",
"meta": {
"range": [
3997,
4259
],
"filename": "Matrix.js",
"lineno": 164,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100092175",
"name": "Matrix#apply",
"type": "MethodDefinition",
"paramnames": [
"pos",
"newPos"
]
},
"vars": {
"": null
}
},
"description": "Get a new position with the current transformation applied.
",
"params": [
{
"type": {
"names": [
"PIXI.Point"
]
},
"description": "The origin
",
"name": "pos"
},
{
"type": {
"names": [
"PIXI.Point"
]
},
"optional": true,
"description": "The point that the new position is assigned to (allowed to be same as input)
",
"name": "newPos"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Point"
]
},
"description": "The new point, transformed through this matrix
"
}
],
"name": "apply",
"longname": "PIXI.Matrix#apply",
"kind": "function",
"memberof": "PIXI.Matrix",
"scope": "instance",
"___id": "T000002R008584",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixapply",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * Get a new position with the inverse of the current transformation applied.\n * Can be used to go from the world coordinate space to a child's coordinate space. (e.g. input)\n *\n * @param {PIXI.Point} pos - The origin\n * @param {PIXI.Point} [newPos] - The point that the new position is assigned to (allowed to be same as input)\n * @return {PIXI.Point} The new point, inverse-transformed through this matrix\n */",
"meta": {
"range": [
4713,
5153
],
"filename": "Matrix.js",
"lineno": 185,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100092242",
"name": "Matrix#applyInverse",
"type": "MethodDefinition",
"paramnames": [
"pos",
"newPos"
]
},
"vars": {
"": null
}
},
"description": "Get a new position with the inverse of the current transformation applied.
",
"params": [
{
"type": {
"names": [
"PIXI.Point"
]
},
"description": "The origin
",
"name": "pos"
},
{
"type": {
"names": [
"PIXI.Point"
]
},
"optional": true,
"description": "The point that the new position is assigned to (allowed to be same as input)
",
"name": "newPos"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Point"
]
},
"description": "The new point, inverse-transformed through this matrix
"
}
],
"name": "applyInverse",
"longname": "PIXI.Matrix#applyInverse",
"kind": "function",
"memberof": "PIXI.Matrix",
"scope": "instance",
"___id": "T000002R008590",
"___s": true,
"skip": true,
"slug": "PIXI.MatrixapplyInverse",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * Translates the matrix on the x and y.\n *\n * @param {number} x How much to translate x by\n * @param {number} y How much to translate y by\n * @return {PIXI.Matrix} This matrix. Good for chaining method calls.\n */",
"meta": {
"range": [
5405,
5498
],
"filename": "Matrix.js",
"lineno": 207,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100092369",
"name": "Matrix#translate",
"type": "MethodDefinition",
"paramnames": [
"x",
"y"
]
},
"vars": {
"": null
}
},
"description": "Translates the matrix on the x and y.
",
"params": [
{
"type": {
"names": [
"number"
]
},
"description": "How much to translate x by
",
"name": "x"
},
{
"type": {
"names": [
"number"
]
},
"description": "How much to translate y by
",
"name": "y"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Matrix"
]
},
"description": "This matrix. Good for chaining method calls.
"
}
],
"name": "translate",
"longname": "PIXI.Matrix#translate",
"kind": "function",
"memberof": "PIXI.Matrix",
"scope": "instance",
"___id": "T000002R008597",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixtranslate",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * Applies a scale transformation to the matrix.\n *\n * @param {number} x The amount to scale horizontally\n * @param {number} y The amount to scale vertically\n * @return {PIXI.Matrix} This matrix. Good for chaining method calls.\n */",
"meta": {
"range": [
5768,
5941
],
"filename": "Matrix.js",
"lineno": 222,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100092389",
"name": "Matrix#scale",
"type": "MethodDefinition",
"paramnames": [
"x",
"y"
]
},
"vars": {
"": null
}
},
"description": "Applies a scale transformation to the matrix.
",
"params": [
{
"type": {
"names": [
"number"
]
},
"description": "The amount to scale horizontally
",
"name": "x"
},
{
"type": {
"names": [
"number"
]
},
"description": "The amount to scale vertically
",
"name": "y"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Matrix"
]
},
"description": "This matrix. Good for chaining method calls.
"
}
],
"name": "scale",
"longname": "PIXI.Matrix#scale",
"kind": "function",
"memberof": "PIXI.Matrix",
"scope": "instance",
"___id": "T000002R008600",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixscale",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * Applies a rotation transformation to the matrix.\n *\n * @param {number} angle - The angle in radians.\n * @return {PIXI.Matrix} This matrix. Good for chaining method calls.\n */",
"meta": {
"range": [
6153,
6641
],
"filename": "Matrix.js",
"lineno": 240,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100092433",
"name": "Matrix#rotate",
"type": "MethodDefinition",
"paramnames": [
"angle"
]
},
"vars": {
"": null
}
},
"description": "Applies a rotation transformation to the matrix.
",
"params": [
{
"type": {
"names": [
"number"
]
},
"description": "The angle in radians.
",
"name": "angle"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Matrix"
]
},
"description": "This matrix. Good for chaining method calls.
"
}
],
"name": "rotate",
"longname": "PIXI.Matrix#rotate",
"kind": "function",
"memberof": "PIXI.Matrix",
"scope": "instance",
"___id": "T000002R008607",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixrotate",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * Appends the given Matrix to this Matrix.\n *\n * @param {PIXI.Matrix} matrix - The matrix to append.\n * @return {PIXI.Matrix} This matrix. Good for chaining method calls.\n */",
"meta": {
"range": [
6851,
7347
],
"filename": "Matrix.js",
"lineno": 265,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100092558",
"name": "Matrix#append",
"type": "MethodDefinition",
"paramnames": [
"matrix"
]
},
"vars": {
"": null
}
},
"description": "Appends the given Matrix to this Matrix.
",
"params": [
{
"type": {
"names": [
"PIXI.Matrix"
]
},
"description": "The matrix to append.
",
"name": "matrix"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Matrix"
]
},
"description": "This matrix. Good for chaining method calls.
"
}
],
"name": "append",
"longname": "PIXI.Matrix#append",
"kind": "function",
"memberof": "PIXI.Matrix",
"scope": "instance",
"___id": "T000002R008619",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixappend",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * Sets the matrix based on all the available properties\n *\n * @param {number} x - Position on the x axis\n * @param {number} y - Position on the y axis\n * @param {number} pivotX - Pivot on the x axis\n * @param {number} pivotY - Pivot on the y axis\n * @param {number} scaleX - Scale on the x axis\n * @param {number} scaleY - Scale on the y axis\n * @param {number} rotation - Rotation in radians\n * @param {number} skewX - Skew on the x axis\n * @param {number} skewY - Skew on the y axis\n * @return {PIXI.Matrix} This matrix. Good for chaining method calls.\n */",
"meta": {
"range": [
7973,
8693
],
"filename": "Matrix.js",
"lineno": 297,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100092693",
"name": "Matrix#setTransform",
"type": "MethodDefinition",
"paramnames": [
"x",
"y",
"pivotX",
"pivotY",
"scaleX",
"scaleY",
"rotation",
"skewX",
"skewY"
]
},
"vars": {
"": null
}
},
"description": "Sets the matrix based on all the available properties
",
"params": [
{
"type": {
"names": [
"number"
]
},
"description": "Position on the x axis
",
"name": "x"
},
{
"type": {
"names": [
"number"
]
},
"description": "Position on the y axis
",
"name": "y"
},
{
"type": {
"names": [
"number"
]
},
"description": "Pivot on the x axis
",
"name": "pivotX"
},
{
"type": {
"names": [
"number"
]
},
"description": "Pivot on the y axis
",
"name": "pivotY"
},
{
"type": {
"names": [
"number"
]
},
"description": "Scale on the x axis
",
"name": "scaleX"
},
{
"type": {
"names": [
"number"
]
},
"description": "Scale on the y axis
",
"name": "scaleY"
},
{
"type": {
"names": [
"number"
]
},
"description": "Rotation in radians
",
"name": "rotation"
},
{
"type": {
"names": [
"number"
]
},
"description": "Skew on the x axis
",
"name": "skewX"
},
{
"type": {
"names": [
"number"
]
},
"description": "Skew on the y axis
",
"name": "skewY"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Matrix"
]
},
"description": "This matrix. Good for chaining method calls.
"
}
],
"name": "setTransform",
"longname": "PIXI.Matrix#setTransform",
"kind": "function",
"memberof": "PIXI.Matrix",
"scope": "instance",
"___id": "T000002R008630",
"___s": true,
"skip": true,
"slug": "PIXI.MatrixsetTransform",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * Prepends the given Matrix to this Matrix.\n *\n * @param {PIXI.Matrix} matrix - The matrix to prepend\n * @return {PIXI.Matrix} This matrix. Good for chaining method calls.\n */",
"meta": {
"range": [
8904,
9531
],
"filename": "Matrix.js",
"lineno": 328,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100092858",
"name": "Matrix#prepend",
"type": "MethodDefinition",
"paramnames": [
"matrix"
]
},
"vars": {
"": null
}
},
"description": "Prepends the given Matrix to this Matrix.
",
"params": [
{
"type": {
"names": [
"PIXI.Matrix"
]
},
"description": "The matrix to prepend
",
"name": "matrix"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Matrix"
]
},
"description": "This matrix. Good for chaining method calls.
"
}
],
"name": "prepend",
"longname": "PIXI.Matrix#prepend",
"kind": "function",
"memberof": "PIXI.Matrix",
"scope": "instance",
"___id": "T000002R008647",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixprepend",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * Decomposes the matrix (x, y, scaleX, scaleY, and rotation) and sets the properties on to a transform.\n *\n * @param {PIXI.Transform|PIXI.TransformStatic} transform - The transform to apply the properties to.\n * @return {PIXI.Transform|PIXI.TransformStatic} The transform with the newly applied properties\n */",
"meta": {
"range": [
9876,
10862
],
"filename": "Matrix.js",
"lineno": 355,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100093024",
"name": "Matrix#decompose",
"type": "MethodDefinition",
"paramnames": [
"transform"
]
},
"vars": {
"": null
}
},
"description": "Decomposes the matrix (x, y, scaleX, scaleY, and rotation) and sets the properties on to a transform.
",
"params": [
{
"type": {
"names": [
"PIXI.Transform",
"PIXI.TransformStatic"
]
},
"description": "The transform to apply the properties to.
",
"name": "transform"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Transform",
"PIXI.TransformStatic"
]
},
"description": "The transform with the newly applied properties
"
}
],
"name": "decompose",
"longname": "PIXI.Matrix#decompose",
"kind": "function",
"memberof": "PIXI.Matrix",
"scope": "instance",
"___id": "T000002R008657",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixdecompose",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * Inverts this matrix\n *\n * @return {PIXI.Matrix} This matrix. Good for chaining method calls.\n */",
"meta": {
"range": [
10992,
11422
],
"filename": "Matrix.js",
"lineno": 401,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100093210",
"name": "Matrix#invert",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Inverts this matrix
",
"returns": [
{
"type": {
"names": [
"PIXI.Matrix"
]
},
"description": "This matrix. Good for chaining method calls.
"
}
],
"name": "invert",
"longname": "PIXI.Matrix#invert",
"kind": "function",
"memberof": "PIXI.Matrix",
"scope": "instance",
"params": [],
"___id": "T000002R008675",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixinvert",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * Resets this Matix to an identity (default) matrix.\n *\n * @return {PIXI.Matrix} This matrix. Good for chaining method calls.\n */",
"meta": {
"range": [
11583,
11749
],
"filename": "Matrix.js",
"lineno": 425,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100093323",
"name": "Matrix#identity",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Resets this Matix to an identity (default) matrix.
",
"returns": [
{
"type": {
"names": [
"PIXI.Matrix"
]
},
"description": "This matrix. Good for chaining method calls.
"
}
],
"name": "identity",
"longname": "PIXI.Matrix#identity",
"kind": "function",
"memberof": "PIXI.Matrix",
"scope": "instance",
"params": [],
"___id": "T000002R008688",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixidentity",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * Creates a new Matrix object with the same values as this one.\n *\n * @return {PIXI.Matrix} A copy of this matrix. Good for chaining method calls.\n */",
"meta": {
"range": [
11931,
12178
],
"filename": "Matrix.js",
"lineno": 442,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100093365",
"name": "Matrix#clone",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Creates a new Matrix object with the same values as this one.
",
"returns": [
{
"type": {
"names": [
"PIXI.Matrix"
]
},
"description": "A copy of this matrix. Good for chaining method calls.
"
}
],
"name": "clone",
"longname": "PIXI.Matrix#clone",
"kind": "function",
"memberof": "PIXI.Matrix",
"scope": "instance",
"params": [],
"___id": "T000002R008695",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixclone",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * Changes the values of the given matrix to be the same as the ones in this matrix\n *\n * @param {PIXI.Matrix} matrix - The matrix to copy from.\n * @return {PIXI.Matrix} The matrix given in parameter with its values updated.\n */",
"meta": {
"range": [
12441,
12655
],
"filename": "Matrix.js",
"lineno": 462,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100093424",
"name": "Matrix#copy",
"type": "MethodDefinition",
"paramnames": [
"matrix"
]
},
"vars": {
"": null
}
},
"description": "Changes the values of the given matrix to be the same as the ones in this matrix
",
"params": [
{
"type": {
"names": [
"PIXI.Matrix"
]
},
"description": "The matrix to copy from.
",
"name": "matrix"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Matrix"
]
},
"description": "The matrix given in parameter with its values updated.
"
}
],
"name": "copy",
"longname": "PIXI.Matrix#copy",
"kind": "function",
"memberof": "PIXI.Matrix",
"scope": "instance",
"___id": "T000002R008703",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixcopy",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * A default (identity) matrix\n *\n * @static\n * @const\n */",
"meta": {
"range": [
12748,
12810
],
"filename": "Matrix.js",
"lineno": 480,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100093479",
"name": "Matrix.IDENTITY",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "A default (identity) matrix
",
"scope": "static",
"kind": "constant",
"name": "IDENTITY",
"longname": "PIXI.Matrix.IDENTITY",
"memberof": "PIXI.Matrix",
"params": [],
"___id": "T000002R008710",
"___s": true,
"skip": true,
"slug": "PIXI.Matrix.IDENTITY",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * A temp matrix\n *\n * @static\n * @const\n */",
"meta": {
"range": [
12889,
12954
],
"filename": "Matrix.js",
"lineno": 491,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {
"id": "astnode100093486",
"name": "Matrix.TEMP_MATRIX",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "A temp matrix
",
"scope": "static",
"kind": "constant",
"name": "TEMP_MATRIX",
"longname": "PIXI.Matrix.TEMP_MATRIX",
"memberof": "PIXI.Matrix",
"params": [],
"___id": "T000002R008711",
"___s": true,
"skip": true,
"slug": "PIXI.Matrix.TEMP_MATRIX",
"filepath": "core\\math\\Matrix.js"
}
],
"$attributes": [
{
"comment": "/**\n * @member {number} PIXI.Matrix#a\n * @default 1\n */",
"meta": {
"range": [
599,
678
],
"filename": "Matrix.js",
"lineno": 27,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {}
},
"kind": "member",
"name": "a",
"type": {
"names": [
"number"
]
},
"defaultvalue": "1",
"memberof": "PIXI.Matrix",
"longname": "PIXI.Matrix#a",
"scope": "instance",
"___id": "T000002R001602",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixa",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * @member {number} PIXI.Matrix#b\n * @default 0\n */",
"meta": {
"range": [
708,
787
],
"filename": "Matrix.js",
"lineno": 33,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {}
},
"kind": "member",
"name": "b",
"type": {
"names": [
"number"
]
},
"defaultvalue": "0",
"memberof": "PIXI.Matrix",
"longname": "PIXI.Matrix#b",
"scope": "instance",
"___id": "T000002R001604",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixb",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * @member {number} PIXI.Matrix#c\n * @default 0\n */",
"meta": {
"range": [
817,
896
],
"filename": "Matrix.js",
"lineno": 39,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {}
},
"kind": "member",
"name": "c",
"type": {
"names": [
"number"
]
},
"defaultvalue": "0",
"memberof": "PIXI.Matrix",
"longname": "PIXI.Matrix#c",
"scope": "instance",
"___id": "T000002R001606",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixc",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * @member {number} PIXI.Matrix#d\n * @default 1\n */",
"meta": {
"range": [
926,
1005
],
"filename": "Matrix.js",
"lineno": 45,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {}
},
"kind": "member",
"name": "d",
"type": {
"names": [
"number"
]
},
"defaultvalue": "1",
"memberof": "PIXI.Matrix",
"longname": "PIXI.Matrix#d",
"scope": "instance",
"___id": "T000002R001608",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixd",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * @member {number} PIXI.Matrix#tx\n * @default 0\n */",
"meta": {
"range": [
1035,
1115
],
"filename": "Matrix.js",
"lineno": 51,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {}
},
"kind": "member",
"name": "tx",
"type": {
"names": [
"number"
]
},
"defaultvalue": "0",
"memberof": "PIXI.Matrix",
"longname": "PIXI.Matrix#tx",
"scope": "instance",
"___id": "T000002R001610",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixtx",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * @member {number} PIXI.Matrix#ty\n * @default 0\n */",
"meta": {
"range": [
1147,
1227
],
"filename": "Matrix.js",
"lineno": 57,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {}
},
"kind": "member",
"name": "ty",
"type": {
"names": [
"number"
]
},
"defaultvalue": "0",
"memberof": "PIXI.Matrix",
"longname": "PIXI.Matrix#ty",
"scope": "instance",
"___id": "T000002R001612",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixty",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * @member {number} PIXI.Matrix#a\n * @default 1\n */",
"meta": {
"range": [
599,
678
],
"filename": "Matrix.js",
"lineno": 27,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {}
},
"kind": "member",
"name": "a",
"type": {
"names": [
"number"
]
},
"defaultvalue": "1",
"memberof": "PIXI.Matrix",
"longname": "PIXI.Matrix#a",
"scope": "instance",
"___id": "T000002R008536",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixa",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * @member {number} PIXI.Matrix#b\n * @default 0\n */",
"meta": {
"range": [
708,
787
],
"filename": "Matrix.js",
"lineno": 33,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {}
},
"kind": "member",
"name": "b",
"type": {
"names": [
"number"
]
},
"defaultvalue": "0",
"memberof": "PIXI.Matrix",
"longname": "PIXI.Matrix#b",
"scope": "instance",
"___id": "T000002R008538",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixb",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * @member {number} PIXI.Matrix#c\n * @default 0\n */",
"meta": {
"range": [
817,
896
],
"filename": "Matrix.js",
"lineno": 39,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {}
},
"kind": "member",
"name": "c",
"type": {
"names": [
"number"
]
},
"defaultvalue": "0",
"memberof": "PIXI.Matrix",
"longname": "PIXI.Matrix#c",
"scope": "instance",
"___id": "T000002R008540",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixc",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * @member {number} PIXI.Matrix#d\n * @default 1\n */",
"meta": {
"range": [
926,
1005
],
"filename": "Matrix.js",
"lineno": 45,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {}
},
"kind": "member",
"name": "d",
"type": {
"names": [
"number"
]
},
"defaultvalue": "1",
"memberof": "PIXI.Matrix",
"longname": "PIXI.Matrix#d",
"scope": "instance",
"___id": "T000002R008542",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixd",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * @member {number} PIXI.Matrix#tx\n * @default 0\n */",
"meta": {
"range": [
1035,
1115
],
"filename": "Matrix.js",
"lineno": 51,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {}
},
"kind": "member",
"name": "tx",
"type": {
"names": [
"number"
]
},
"defaultvalue": "0",
"memberof": "PIXI.Matrix",
"longname": "PIXI.Matrix#tx",
"scope": "instance",
"___id": "T000002R008544",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixtx",
"filepath": "core\\math\\Matrix.js"
},
{
"comment": "/**\n * @member {number} PIXI.Matrix#ty\n * @default 0\n */",
"meta": {
"range": [
1147,
1227
],
"filename": "Matrix.js",
"lineno": 57,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math",
"code": {}
},
"kind": "member",
"name": "ty",
"type": {
"names": [
"number"
]
},
"defaultvalue": "0",
"memberof": "PIXI.Matrix",
"longname": "PIXI.Matrix#ty",
"scope": "instance",
"___id": "T000002R008546",
"___s": true,
"skip": true,
"slug": "PIXI.Matrixty",
"filepath": "core\\math\\Matrix.js"
}
],
"$staticmethods": [],
"$staticproperties": [],
"$augments": [],
"$augmentedBy": [],
"filepath": "core\\math\\Matrix.js"
}