Matrix.md
October 15, 2018 · View on GitHub
Matrix
Kind: class
- Matrix
- new Matrix(a, b, c, d, e, f)
- .setFrom(otherMatrix)
- .clone() ⇒ !Matrix
- .add(a, b, c, d, e, f) ⇒ !Matrix
- .multLeft(a, b, c, d, e, f) ⇒ !Matrix
- .invert() ⇒ !Matrix
- .translate(tx, ty) ⇒ !Matrix
- .scale(sx, sy, tx, ty) ⇒ !Matrix
- .rotate(a, x, y) ⇒ !Matrix
- .x(x, y) ⇒
number - .y(x, y) ⇒
number - .transformPoint(point) ⇒
!{x:number, y:number} - .transformRect(rect) ⇒
!{x:number, y:number, width:number, height:number} - .getTranslate() ⇒
!Array.<number> - .determinant() ⇒
number - .split() ⇒
!{dx:number, dy:number, scaleX:number, scaleY:number, shear:number, rotate:number, isSimple:boolean} - .scaleFactors([flipInfo]) ⇒
!{scaleX:number, scaleY:number} - .removedScaleMatrix(scaleX, scaleY) ⇒ !Matrix
- .hasSkew() ⇒
boolean - .getRotation() ⇒
number
new Matrix(a, b, c, d, e, f)
Creates a new transform matrix with the following structure:
| a c e |
| b d f |
| 0 0 1 |
Note: XD does not generally allow transform matrices with scale or shear (skew) components - only translate and rotate components are typically permitted.
If no arguments, creates a new identity matrix by default.
matrix.setFrom(otherMatrix)
Copies another matrix's values into this matrix.
Kind: instance method of Matrix
| Param | Type | Description |
|---|---|---|
| otherMatrix | !Matrix | The matrix to copy values from. |
matrix.clone()
Returns a copy of the matrix
Kind: instance method of Matrix
Returns: !Matrix
matrix.add(aOrMatrix, b, c, d, e, f) ⇒ !Matrix
Multiplies a passed affine transform to the right: this * M. The result effectively applies the transform of the passed in matrix first, followed by the transform of this matrix second. Modifies this matrix object and also returns it so calls can be chained.
Kind: instance method of Matrix
Returns: !Matrix - The current matrix after right multiply.
| Param | Type | Description |
|---|---|---|
| aOrMatrix | number | !Matrix |
| b | ?number | The b component of an affine transform. |
| c | ?number | The c component of an affine transform. |
| d | ?number | The d component of an affine transform. |
| e | ?number | The e component of an affine transform. |
| f | ?number | The f component of an affine transform. |
matrix.multLeft(aOrMatrix, b, c, d, e, f) ⇒ !Matrix
Multiplies a passed affine transform to the left: M * this. The result effectively applies the transform of this matrix first, followed by the transform of the passed in matrix second. Modifies this matrix object and also returns it so calls can be chained.
Kind: instance method of Matrix
Returns: !Matrix - The current matrix after left multiply.
| Param | Type | Description |
|---|---|---|
| aOrMatrix | number | !Matrix |
| b | ?number | The b component of an affine transform. |
| c | ?number | The c component of an affine transform. |
| d | ?number | The d component of an affine transform. |
| e | ?number | The e component of an affine transform. |
| f | ?number | The f component of an affine transform. |
matrix.invert() ⇒ !Matrix
Returns an inverted version of the matrix. Returns a brand new matrix - does not modify this matrix object.
Kind: instance method of Matrix
Returns: !Matrix
matrix.translate(tx, ty) ⇒ !Matrix
Applies translation before the current transform of this matrix, as if using the add() method.
Modifies this matrix object and also returns it so calls can be chained.
Kind: instance method of Matrix
Returns: !Matrix
| Param | Type | Description |
|---|---|---|
| tx | number | horizontal offset distance |
| ty | number | vertical offset distance |
matrix.scale(sx, sy, cx, cy) ⇒ !Matrix
Applies scaling before the current transform of this matrix, as if using the add() method.
Modifies this matrix object and also returns it so calls can be chained.
Note: scale transforms are not generally permitted in XD.
Kind: instance method of Matrix
Returns: !Matrix
| Param | Type | Description |
|---|---|---|
| sx | number | amount to be scaled, with 1 resulting in no change |
| sy | ?number | amount to scale along the vertical axis. (Otherwise sx applies to both axes.) |
| cx | ?number | horizontal origin point from which to scale (if unspecified, scales from the local coordinates' origin point) |
| cy | ?number | vertical origin point from which to scale |
matrix.rotate(angle, cx, cy) ⇒ !Matrix
Applies clockwise rotation before the current transform of this matrix, as if using the add() method.
Modifies this matrix object and also returns it so calls can be chained.
Kind: instance method of Matrix
Returns: !Matrix
| Param | Type | Description |
|---|---|---|
| angle | number | angle of rotation, in degrees clockwise |
| cx | ?number | horizontal origin point from which to rotate (if unspecified, scales from the local coordinates' origin point) |
| cy | ?number | vertical origin point from which to rotate |
matrix.x(x, y) ⇒ number
Returns x coordinate of the given point after transformation described by this matrix. See also Matrix.y and Matrix.transformPoint.
Kind: instance method of Matrix
Returns: number
| Param | Type |
|---|---|
| x | number |
| y | number |
matrix.y(x, y) ⇒ number
Returns y coordinate of the given point after transformation described by this matrix. See also Matrix.x and Matrix.transformPoint.
Kind: instance method of Matrix
Returns: number
| Param | Type |
|---|---|
| x | number |
| y | number |
matrix.transformPoint(point) ⇒ !{x:number, y:number}
Returns x & y coordinates of the given point after transformation described by this matrix.
Kind: instance method of Matrix
Returns: !{x:number, y:number}
| Param | Type |
|---|---|
| point | !{x:number, y:number} |
matrix.transformRect(rect) ⇒ !{x:number, y:number, width:number, height:number}
Transforms a rectangle using this matrix, returning the axis-aligned bounds of the resulting rectangle. If this matrix has rotation, then the result will have different width & height from the original rectangle, due to axis alignment. See "Coordinate Spaces" for some illustrations of this.
Kind: instance method of Matrix
Returns: !{x:number, y:number, width:number, height:number}
| Param | Type |
|---|---|
| rect | !{x:number, y:number, width:number, height:number} |
matrix.getTranslate() ⇒ !Array.<number>
Kind: instance method of Matrix
Returns: !Array.<number> - The translation component of this matrix: [tx, ty]. Equals the e and f components of this matrix.
matrix.scaleFactors() ⇒ !{scaleX:number, scaleY:number}
Split the matrix into scale factors. This method assumes that there is no skew in the matrix.
Kind: instance method of Matrix
Returns: !{scaleX:number, scaleY:number}
matrix.removedScaleMatrix(scaleX, scaleY) ⇒ !Matrix
Returns a new matrix that contains only the translate and rotate components of the current matrix, with the given scale factors stripped out. Must be passed the exact scale factors returned by scaleFactors() for this matrix, and this matrix must have no skew/shear component.
Returns a brand new matrix - does not modify this matrix object.
Kind: instance method of Matrix
Returns: !Matrix - The matrix without the passed scaling factors.
| Param | Type | Description |
|---|---|---|
| scaleX | number | horrizontal scale component to remove |
| scaleY | number | vertical scale component to remove |
matrix.hasSkew() ⇒ boolean
Kind: instance method of Matrix
Returns: boolean - true, if the matrix includes any skew (shear)