Class Matrix

Matrix 类表示一个转换矩阵，它确定如何将点从一个坐标空间映射到另一个坐标空间。您可以对一个显示对象执行不同的图形转换，方法是设置 Matrix 对象的属性，将该 Matrix 对象应用于显示对象的 matrix 属性。这些转换函数包括平移（x 和 y 重新定位）、旋转、缩放和倾斜。

Version

Egret 2.4

Platform

Web

Include Example

egret/geom/Matrix.ts

Language

zh_CN

Hierarchy (View Summary)

HashObject
- Matrix

Index

Constructors

constructor

new Matrix(
    a?: number,
    b?: number,
    c?: number,
    d?: number,
    tx?: number,
    ty?: number,
): Matrix
使用指定参数创建一个 Matrix 对象
Parameters
- a: number = 1
  缩放或旋转图像时影响像素沿 x 轴定位的值。
- b: number = 0
  旋转或倾斜图像时影响像素沿 y 轴定位的值。
- c: number = 0
  旋转或倾斜图像时影响像素沿 x 轴定位的值。
- d: number = 1
  缩放或旋转图像时影响像素沿 y 轴定位的值。
- tx: number = 0
  沿 x 轴平移每个点的距离。
- ty: number = 0
  沿 y 轴平移每个点的距离。
Returns Matrix

Version
Egret 2.4

Platform
Web

Language
zh_CN
Overrides HashObject.constructor
- Defined in egret/geom/Matrix.ts:101

Properties

a

a: number

缩放或旋转图像时影响像素沿 x 轴定位的值

Default

Version

Egret 2.4

Platform

Web

Language

zh_CN

b

b: number

旋转或倾斜图像时影响像素沿 y 轴定位的值

Default

Version

Egret 2.4

Platform

Web

Language

zh_CN

c

c: number

旋转或倾斜图像时影响像素沿 x 轴定位的值

Default

Version

Egret 2.4

Platform

Web

Language

zh_CN

d

d: number

缩放或旋转图像时影响像素沿 y 轴定位的值

Default

Version

Egret 2.4

Platform

Web

Language

zh_CN

tx

tx: number

沿 x 轴平移每个点的距离

Default

Version

Egret 2.4

Platform

Web

Language

zh_CN

ty

ty: number

沿 y 轴平移每个点的距离

Default

Version

Egret 2.4

Platform

Web

Language

zh_CN

Accessors

hashCode

get hashCode(): number
返回此对象唯一的哈希值,用于唯一确定一个对象。hashCode为大于等于1的整数。

Returns number

Version
Egret 2.4

Platform
Web

Language
zh_CN
Inherited from HashObject.hashCode
- Defined in egret/utils/HashObject.ts:102

Methods

`Static`release

release(matrix: Matrix): void
释放一个Matrix实例到对象池
Parameters
- matrix: Matrix
  需要回收的 matrix
Returns void

Version
Egret 2.4

Platform
Web

Language
zh_CN
- Defined in egret/geom/Matrix.ts:50

`Static`create

create(): Matrix
从对象池中取出或创建一个新的Matrix对象。

Returns Matrix

Version
Egret 2.4

Platform
Web

Language
zh_CN
- Defined in egret/geom/Matrix.ts:69

clone

clone(): Matrix
返回一个新的 Matrix 对象，它是此矩阵的克隆，带有与所含对象完全相同的副本。

Returns Matrix

Version
Egret 2.4

Platform
Web

Language
zh_CN
- Defined in egret/geom/Matrix.ts:215

concat

concat(other: Matrix): void
将某个矩阵与当前矩阵连接，从而将这两个矩阵的几何效果有效地结合在一起。在数学术语中，将两个矩阵连接起来与使用矩阵乘法将它们结合起来是相同的。
Parameters
- other: Matrix
  要连接到源矩阵的矩阵。
Returns void

Version
Egret 2.4

Platform
Web

Language
zh_CN
- Defined in egret/geom/Matrix.ts:234

copyFrom

copyFrom(other: Matrix): Matrix
将源 Matrix 对象中的所有矩阵数据复制到调用方 Matrix 对象中。
Parameters
- other: Matrix
  要拷贝的目标矩阵
Returns Matrix

Version
Egret 2.4

Platform
Web

Language
zh_CN
- Defined in egret/geom/Matrix.ts:273

identity

identity(): void
为每个矩阵属性设置一个值，该值将导致矩阵无转换。通过应用恒等矩阵转换的对象将与原始对象完全相同。调用 identity() 方法后，生成的矩阵具有以下属性：a=1、b=0、c=0、d=1、tx=0 和 ty=0。

Returns void

Version
Egret 2.4

Platform
Web

Language
zh_CN
- Defined in egret/geom/Matrix.ts:298

invert

invert(): void
执行原始矩阵的逆转换。您可以将一个逆矩阵应用于对象来撤消在应用原始矩阵时执行的转换。

Returns void

Version
Egret 2.4

Platform
Web

Language
zh_CN
- Defined in egret/geom/Matrix.ts:317

rotate

rotate(angle: number): void
对 Matrix 对象应用旋转转换。 rotate() 方法将更改 Matrix 对象的 a、b、c 和 d 属性。
Parameters
- angle: number
  以弧度为单位的旋转角度。
Returns void

Version
Egret 2.4

Platform
Web

Language
zh_CN
- Defined in egret/geom/Matrix.ts:375

scale

scale(sx: number, sy: number): void
对矩阵应用缩放转换。x 轴乘以 sx，y 轴乘以 sy。 scale() 方法将更改 Matrix 对象的 a 和 d 属性。
Parameters
- sx: number
  用于沿 x 轴缩放对象的乘数。
- sy: number
  用于沿 y 轴缩放对象的乘数。
Returns void

Version
Egret 2.4

Platform
Web

Language
zh_CN
- Defined in egret/geom/Matrix.ts:414

setTo

setTo(
    a: number,
    b: number,
    c: number,
    d: number,
    tx: number,
    ty: number,
): Matrix
将 Matrix 的成员设置为指定值
Parameters
- a: number
  缩放或旋转图像时影响像素沿 x 轴定位的值。
- b: number
  旋转或倾斜图像时影响像素沿 y 轴定位的值。
- c: number
  旋转或倾斜图像时影响像素沿 x 轴定位的值。
- d: number
  缩放或旋转图像时影响像素沿 y 轴定位的值。
- tx: number
  沿 x 轴平移每个点的距离。
- ty: number
  沿 y 轴平移每个点的距离。
Returns Matrix

Version
Egret 2.4

Platform
Web

Language
zh_CN
- Defined in egret/geom/Matrix.ts:451

transformPoint

transformPoint(pointX: number, pointY: number, resultPoint?: Point): Point
返回将 Matrix 对象表示的几何转换应用于指定点所产生的结果。
Parameters
- pointX: number
  想要获得其矩阵转换结果的点的x坐标。
- pointY: number
  想要获得其矩阵转换结果的点的y坐标。
- OptionalresultPoint: Point
  框架建议尽可能减少创建对象次数来优化性能，可以从外部传入一个复用的Point对象来存储结果，若不传入将创建一个新的Point对象返回。
Returns Point
由应用矩阵转换所产生的点。

Version
Egret 2.4

Platform
Web

Language
zh_CN
- Defined in egret/geom/Matrix.ts:482

translate

translate(dx: number, dy: number): void
沿 x 和 y 轴平移矩阵，由 dx 和 dy 参数指定。
Parameters
- dx: number
  沿 x 轴向右移动的量（以像素为单位）。
- dy: number
  沿 y 轴向下移动的量（以像素为单位）。
Returns void

Version
Egret 2.4

Platform
Web

Language
zh_CN
- Defined in egret/geom/Matrix.ts:508

equals

equals(other: Matrix): boolean
是否与另一个矩阵数据相等
Parameters
- other: Matrix
  要比较的另一个矩阵对象。
Returns boolean
是否相等，ture表示相等。

Version
Egret 2.4

Platform
Web

Language
zh_CN
- Defined in egret/geom/Matrix.ts:529

prepend

prepend(
    a: number,
    b: number,
    c: number,
    d: number,
    tx: number,
    ty: number,
): Matrix
前置矩阵
Parameters
- a: number
  缩放或旋转图像时影响像素沿 x 轴定位的值
- b: number
  缩放或旋转图像时影响像素沿 y 轴定位的值
- c: number
  缩放或旋转图像时影响像素沿 x 轴定位的值
- d: number
  缩放或旋转图像时影响像素沿 y 轴定位的值
- tx: number
  沿 x 轴平移每个点的距离
- ty: number
  沿 y 轴平移每个点的距离
Returns Matrix
矩阵自身

Version
Egret 2.4

Platform
Web

Language
zh_CN
- Defined in egret/geom/Matrix.ts:561

append

append(
    a: number,
    b: number,
    c: number,
    d: number,
    tx: number,
    ty: number,
): Matrix
后置矩阵
Parameters
- a: number
  缩放或旋转图像时影响像素沿 x 轴定位的值
- b: number
  缩放或旋转图像时影响像素沿 y 轴定位的值
- c: number
  缩放或旋转图像时影响像素沿 x 轴定位的值
- d: number
  缩放或旋转图像时影响像素沿 y 轴定位的值
- tx: number
  沿 x 轴平移每个点的距离
- ty: number
  沿 y 轴平移每个点的距离
Returns Matrix
矩阵自身

Version
Egret 2.4

Platform
Web

Language
zh_CN
- Defined in egret/geom/Matrix.ts:602

deltaTransformPoint

deltaTransformPoint(point: Point): Point
如果给定预转换坐标空间中的点，则此方法返回发生转换后该点的坐标。与使用 transformPoint() 方法应用的标准转换不同，deltaTransformPoint() 方法的转换不考虑转换参数 tx 和 ty。
Parameters
- point: Point
  想要获得其矩阵转换结果的点
Returns Point
由应用矩阵转换所产生的点

Version
Egret 2.4

Platform
Web

Language
zh_CN
- Defined in egret/geom/Matrix.ts:636

toString

toString(): string
返回将 Matrix 对象表示的几何转换应用于指定点所产生的结果。

Returns string
一个字符串，它包含 Matrix 对象的属性值：a、b、c、d、tx 和 ty。

Version
Egret 2.4

Platform
Web

Language
zh_CN
- Defined in egret/geom/Matrix.ts:657

createBox

createBox(
    scaleX: number,
    scaleY: number,
    rotation?: number,
    tx?: number,
    ty?: number,
): void
包括用于缩放、旋转和转换的参数。当应用于矩阵时，该方法会基于这些参数设置矩阵的值。
Parameters
- scaleX: number
  水平缩放所用的系数
- scaleY: number
  垂直缩放所用的系数
- rotation: number = 0
  旋转量（以弧度为单位）
- tx: number = 0
  沿 x 轴向右平移（移动）的像素数
- ty: number = 0
  沿 y 轴向下平移（移动）的像素数
Returns void

Version
Egret 2.4

Platform
Web

Language
zh_CN
- Defined in egret/geom/Matrix.ts:683

createGradientBox

createGradientBox(
    width: number,
    height: number,
    rotation?: number,
    tx?: number,
    ty?: number,
): void
创建 Graphics 类的 beginGradientFill() 和 lineGradientStyle() 方法所需的矩阵的特定样式。宽度和高度被缩放为 scaleX/scaleY 对，而 tx/ty 值偏移了宽度和高度的一半。
Parameters
- width: number
  渐变框的宽度
- height: number
  渐变框的高度
- rotation: number = 0
  旋转量（以弧度为单位）
- tx: number = 0
  沿 x 轴向右平移的距离（以像素为单位）。此值将偏移 width 参数的一半
- ty: number = 0
  沿 y 轴向下平移的距离（以像素为单位）。此值将偏移 height 参数的一半
Returns void

Version
Egret 2.4

Platform
Web

Language
zh_CN
- Defined in egret/geom/Matrix.ts:727

Class Matrix

Version

Platform

Include Example

Language

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Matrix

Version

Platform

Language

Properties

a

Default

Version

Platform

Language

b

Default

Version

Platform

Language

c

Default

Version

Platform

Language

d

Default

Version

Platform

Language

tx

Default

Version

Platform

Language

ty

Default

Version

Platform

Language

Accessors

hashCode

Returns number

Version

Platform

Language

Methods

Staticrelease

Parameters

Returns void

Version

Platform

Language

Staticcreate

Returns Matrix

Version

Platform

Language

clone

Returns Matrix

Version

Platform

Language

concat

Parameters

Returns void

Version

Platform

Language

copyFrom

Parameters

`Static`release

`Static`create