类 Rectangle

constructor

• new Rectangle(x?, y?, width?, height?): Rectangle

• 参数

  • x: number = 0

    The x coordinate of the top-left corner of the rectangle.
  • y: number = 0

    The y coordinate of the top-left corner of the rectangle.
  • width: number = 0

    The width of the rectangle.
  • height: number = 0

    The height of the rectangle.

  返回 Rectangle

  En

  Constructor method.

  Zh

  构造方法

height

width

x

y

静态 只读EMPTY

静态 只读TEMP

bottom

• get bottom(): number

• 返回 number

  En

  The y-coordinate of the bottom side of this rectangle. It is equal to the sum of the y and height properties.

  Zh

  此矩形底端的 Y 轴坐标。等于 y 和 height 属性的和。

• set bottom(value): void

• 参数

  • value: number

  返回 void

right

• get right(): number

• 返回 number

  En

  The x-coordinate of the right side of this rectangle. It is equal to the sum of the x and width properties.

  Zh

  此矩形右侧的 X 轴坐标。等于 x 和 width 属性的和。

• set right(value): void

• 参数

  • value: number

  返回 void

addPoint

• addPoint(x, y): this

• 参数

  • x: number

    The x-coordinate of the point.
  • y: number

    The y-coordinate of the point.

  返回 this

  This Rectangle object.

  En

  Adds a point to the current rectangle object, expanding it to the smallest rectangle that contains both the current rectangle and the given point. This method modifies the current object.

  Zh

  为当前矩形对象加一个点，以使当前矩形扩展为包含当前矩形和此点的最小矩形。 此方法会修改本对象。

clone

• clone(out?): Rectangle

• 参数

  • 可选out: Rectangle

    (Optional) The rectangle object used to store the result. If null, a new one is created. Recommendation: Reuse objects as much as possible to reduce object creation overhead. The Rectangle.TEMP object can be used for object reuse.

  返回 Rectangle

  A Rectangle object with the same values for x, y, width, and height properties as the current Rectangle object.

  En

  Returns a new Rectangle object with the same values for the x, y, width, and height properties as the original Rectangle object.

  Zh

  返回一个新的 Rectangle 对象，其 x、y、width 和 height 属性的值与当前 Rectangle 对象的对应值相同。

cloneTo

• cloneTo(destObject): void

• 参数

  • destObject: Rectangle

    The destination object to copy to.

  返回 void

  En

  Copies the properties of this Rectangle to the destination object.

  Zh

  将此 Rectangle 的属性复制到目标对象。

contains

• contains(x, y): boolean

• 参数

  • x: number

    The x-coordinate of the point (horizontal position).
  • y: number

    The y-coordinate of the point (vertical position).

  返回 boolean

  True if the Rectangle object contains the specified point; false otherwise.

  En

  Determines whether the specified point is contained within the rectangular region defined by this Rectangle object.

  Zh

  确定由此 Rectangle 对象定义的矩形区域内是否包含指定的点。

copyFrom

• copyFrom(source): this

• 参数

  • source: Rectangle

    The source Rectangle object.

  返回 this

  The rectangle object itself after the property values have been modified.

  En

  Copies the property values from the source Rectangle object to this rectangle object.

  Zh

  复制源 Rectangle 对象的属性值到此矩形对象中。

equals

• equals(rect): boolean

• 参数

  • rect: Rectangle

    The Rectangle object to compare.

  返回 boolean

  True if all properties are equal, false otherwise.

  En

  Checks if the properties of the input Rectangle object are equal to the properties of the current Rectangle object (x, y, width, height).

  Zh

  检测传入的 Rectangle 对象的属性是否与当前 Rectangle 对象的属性 x、y、width、height 属性值都相等。

getBoundPoints

• getBoundPoints(out?): number[]

• 参数

  • 可选out: number[]

  返回 number[]

  Vertex data.

  En

  Returns vertex data representing the current rectangle.

  Zh

  返回代表当前矩形的顶点数据。

intersection

• intersection(rect, out?): Rectangle

• 参数

  • rect: Rectangle

    The rectangle to compare against.
  • 可选out: Rectangle

    (Optional) The rectangle object for storing the output. If null, a new one will be created. It is allowed to be the same as rect or this.

  返回 Rectangle

  The intersection area as a Rectangle object, or null if there's no intersection.

  En

  If the Rectangle object specified in the rect parameter intersects with this Rectangle object, returns the area of intersection as a Rectangle object. If the rectangles do not intersect, this method returns null.

  Zh

  如果在 rect 参数中指定的 Rectangle 对象与此 Rectangle 对象相交，则返回交集区域作为 Rectangle 对象。如果矩形不相交，则此方法返回null。

intersects

• intersects(rect): boolean

• 参数

  • rect: Readonly<Rectangle>

    The Rectangle object to compare.

  返回 boolean

  True if the specified rectangle intersects with this one, false otherwise.

  En

  Determines whether the object specified in the rect parameter intersects with this Rectangle object. This method checks the x, y, width, and height properties of the specified Rectangle object to see if it intersects with this Rectangle object.

  Zh

  确定在 rect 参数中指定的对象是否与此 Rectangle 对象相交。此方法检查指定的 Rectangle 对象的 x、y、width 和 height 属性，以查看它是否与此 Rectangle 对象相交。

isEmpty

• isEmpty(): boolean

• 返回 boolean

  True if the width or height of the Rectangle object is less than or equal to 0, false otherwise.

  En

  Determines whether this Rectangle object is empty.

  Zh

  确定此 Rectangle 对象是否为空。

recover

• recover(): void

• 返回 void

  En

  Recycles the rectangle object.

  Zh

  回收矩形对象。

reset

• reset(): this

• 返回 this

  En

  Resets the rectangle to default values (x=0, y=0, width=0, height=0).

  Zh

  重置矩形为默认值（x=0, y=0, width=0, height=0）。

scale

• scale(scaleX, scaleY): this

• 参数

  • scaleX: number

    X缩放值
  • scaleY: number

    Y缩放值

  返回 this

  本对象

  Zh

  缩放矩形

  En

  Scales the rectangle.

setTo

• setTo(x, y, width, height): this

• 参数

  • x: number

    The x-coordinate of the top-left corner of the rectangle.
  • y: number

    The y-coordinate of the top-left corner of the rectangle.
  • width: number

    The width of the rectangle.
  • height: number

    The height of the rectangle.

  返回 this

  The rectangle object itself after the property values have been modified.

  En

  Sets the properties of the Rectangle to the specified values.

  Zh

  将 Rectangle 的属性设置为指定值。

toString

• toString(): string

• 返回 string

  En

  Returns a string representation of this Rectangle object, with the x, y, width, and height values joined by commas.

  Zh

  返回当前 Rectangle 对象的字符串表示，其中水平位置 x、垂直位置 y、宽度 width 和高度 height 以逗号连接。

transform

• transform(mat, out?): Rectangle

• 参数

  • mat: Matrix

    The transform matrix to be applied.
  • 可选out: Rectangle

  返回 Rectangle

  This object.

  En

  Transforms a rectangle with a transformation matrix.

  Zh

  使用变换矩阵转换矩形。

union

• union(source, out?): Rectangle

• 参数

  • source: Rectangle

    The Rectangle object to add to this Rectangle object.
  • 可选out: Rectangle

    The Rectangle object to store the output. If null, a new one will be created. It is allowed to be the same as rect or this.

  返回 Rectangle

  A new Rectangle object that is the union of the two rectangles.

  En

  Adds two rectangles together to create a new Rectangle object, by filling in the horizontal and vertical space between the two rectangles. Note: The union() method ignores rectangles with a height or width of 0, such as: var rect2:Rectangle = new Rectangle(300,300,50,0);

  Zh

  矩形联合，通过填充两个矩形之间的水平和垂直空间，将这两个矩形组合在一起以创建一个新的 Rectangle 对象。 注意：union() 方法忽略高度或宽度值为 0 的矩形，如：var rect2:Rectangle = new Rectangle(300,300,50,0);

静态_getWrapRec

• _getWrapRec(points, out?): Rectangle

• 参数

  • points: ArrayLike<number>

    List of points.
  • 可选out: Rectangle

    Optional Rectangle object to store the result.

  返回 Rectangle

  The smallest rectangle that contains all the points.

  En

  Returns the smallest rectangle that contains all the points.

  Zh

  返回包含所有点的最小矩形。

静态create

• create(): Rectangle

• 返回 Rectangle

  En

  Creates a new Rectangle object from the object pool.

  Zh

  从对象池中创建一个新的 Rectangle 对象。

静态minMaxRect

• minMaxRect(minX, minY, maxX, maxY, out?): Rectangle

• Creates a rectangle from two corner points.

  参数

  • minX: number

    The smallest x value.
  • minY: number

    The smallest y value.
  • maxX: number

    The largest x value.
  • maxY: number

    The largest y value.
  • 可选out: Rectangle

    Optional Rectangle object to store the result.

  返回 Rectangle

  The resulting rectangle.

  Zh

  由两个角点创建一个矩形。