Class Rectangle

矩形

Rectangle 对象是按其位置(由它左上角的点 (x, y) 确定)以及宽度和高度定义的区域。
Rectangle 类的 x、y、width 和 height 属性相互独立;更改一个属性的值不会影响其他属性。 但是,right 和 bottom 属性与这四个属性是整体相关的。例如,如果更改 right 属性的值,则 width 属性的值将发生变化;如果更改 bottom 属性,则 height 属性的值将发生变化。

Hierarchy

  • Rectangle

Constructors

  • 创建一个新 Rectangle 对象,其左上角由 x 和 y 参数指定,并具有指定的 width 和 height 参数。

    Parameters

    • Optional x: number

      矩形左上角的 x 坐标。

    • Optional y: number

      矩形左上角的 y 坐标。

    • Optional width: number

      矩形的宽度(以像素为单位)。

    • Optional height: number

      矩形的高度(以像素为单位)。

    Returns Rectangle

Properties

height: number

矩形的高度(以像素为单位)。

Default

0
width: number

矩形的宽度(以像素为单位)。

Default

0
x: number

矩形左上角的 x 坐标。

Default

0
y: number

矩形左上角的 y 坐标。

Default

0

Accessors

  • get bottom(): number
  • y 和 height 属性的和。

    Returns number

  • set bottom(value): void
  • Parameters

    • value: number

    Returns void

  • get bottomRight(): Vector2
  • 由 right 和 bottom 属性的值确定的 Rectangle 对象的右下角的位置。

    Returns Vector2

  • set bottomRight(value): void
  • Parameters

    Returns void

  • get center(): Vector2
  • 中心点

    Returns Vector2

  • get left(): number
  • 矩形左上角的 x 坐标。更改 Rectangle 对象的 left 属性对 y 和 height 属性没有影响。但是,它会影响 width 属性,而更改 x 值不会影响 width 属性。 left 属性的值等于 x 属性的值。

    Returns number

  • set left(value): void
  • Parameters

    • value: number

    Returns void

  • get right(): number
  • x 和 width 属性的和。

    Returns number

  • set right(value): void
  • Parameters

    • value: number

    Returns void

  • get size(): Vector2
  • The size of the Rectangle object, expressed as a Point object with the values of the width and height properties.

    Returns Vector2

  • get top(): number
  • 矩形左上角的 y 坐标。更改 Rectangle 对象的 top 属性对 x 和 width 属性没有影响。但是,它会影响 height 属性,而更改 y 值不会影响 height 属性。
    top 属性的值等于 y 属性的值。

    Returns number

  • set top(value): void
  • Parameters

    • value: number

    Returns void

  • get topLeft(): Vector2
  • 由该点的 x 和 y 坐标确定的 Rectangle 对象左上角的位置。

    Returns Vector2

  • set topLeft(value): void
  • Parameters

    Returns void

Methods

  • Parameters

    Returns Vector2

  • 返回一个新的 Rectangle 对象,其 x、y、width 和 height 属性的值与原始 Rectangle 对象的对应值相同。

    Returns Rectangle

    新的 Rectangle 对象,其 x、y、width 和 height 属性的值与原始 Rectangle 对象的对应值相同。

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

    Parameters

    • x: number

      检测点的x轴

    • y: number

      检测点的y轴

    Returns boolean

    如果检测点位于矩形内,返回true,否则,返回false

  • 确定由此 Rectangle 对象定义的矩形区域内是否包含指定的点。 此方法与 Rectangle.contains() 方法类似,只不过它采用 Point 对象作为参数。

    Parameters

    Returns boolean

    如果包含,返回true,否则返回false

  • 确定此 Rectangle 对象内是否包含由 rect 参数指定的 Rectangle 对象。 如果一个 Rectangle 对象完全在另一个 Rectangle 的边界内,我们说第二个 Rectangle 包含第一个 Rectangle。

    Parameters

    • rect: Rectangle

      所检查的 Rectangle 对象

    Returns boolean

    如果此 Rectangle 对象包含您指定的 Rectangle 对象,则返回 true 值,否则返回 false。

  • 将源 Rectangle 对象中的所有矩形数据复制到调用方 Rectangle 对象中。

    Parameters

    • sourceRect: IRectangle

      要从中复制数据的 Rectangle 对象。

    Returns Rectangle

  • 确定在 toCompare 参数中指定的对象是否等于此 Rectangle 对象。 此方法将某个对象的 x、y、width 和 height 属性与此 Rectangle 对象所对应的相同属性进行比较。

    Parameters

    • toCompare: Rectangle

      要与此 Rectangle 对象进行比较的矩形。

    Returns boolean

    如果对象具有与此 Rectangle 对象完全相同的 x、y、width 和 height 属性值,则返回 true 值,否则返回 false。

  • 按指定量增加 Rectangle 对象的大小(以像素为单位) 保持 Rectangle 对象的中心点不变,使用 dx 值横向增加它的大小,使用 dy 值纵向增加它的大小。

    Parameters

    • dx: number

      Rectangle 对象横向增加的值。

    • dy: number

      Rectangle 对象纵向增加的值。

    Returns void

  • 增加 Rectangle 对象的大小。此方法与 Rectangle.inflate() 方法类似,只不过它采用 Point 对象作为参数。

    Parameters

    Returns void

  • 将 Rectangle 的成员设置为指定值

    Parameters

    • x: number

      矩形左上角的 x 坐标。

    • y: number

      矩形左上角的 y 坐标。

    • width: number

      矩形的宽度(以像素为单位)。

    • height: number

      矩形的高度(以像素为单位)。

    Returns Rectangle

  • 如果在 toIntersect 参数中指定的 Rectangle 对象与此 Rectangle 对象相交,则返回交集区域作为 Rectangle 对象。如果矩形不相交, 则此方法返回一个空的 Rectangle 对象,其属性设置为 0。

    Parameters

    • toIntersect: Rectangle

      要对照比较以查看其是否与此 Rectangle 对象相交的 Rectangle 对象。

    Returns Rectangle

    等于交集区域的 Rectangle 对象。如果该矩形不相交,则此方法返回一个空的 Rectangle 对象;即,其 x、y、width 和 height 属性均设置为 0 的矩形。

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

    Parameters

    • toIntersect: Rectangle

      要与此 Rectangle 对象比较的 Rectangle 对象。

    Returns boolean

    如果两个矩形相交,返回true,否则返回false

  • 确定此 Rectangle 对象是否为空。

    Returns boolean

    如果 Rectangle 对象的宽度或高度小于等于 0,则返回 true 值,否则返回 false。

  • 按指定量调整 Rectangle 对象的位置(由其左上角确定)。

    Parameters

    • dx: number

      将 Rectangle 对象的 x 值移动此数量。

    • dy: number

      将 Rectangle 对象的 t 值移动此数量。

    Returns void

  • 将 Point 对象用作参数来调整 Rectangle 对象的位置。此方法与 Rectangle.offset() 方法类似,只不过它采用 Point 对象作为参数。

    Parameters

    • point: Vector2

      要用于偏移此 Rectangle 对象的 Point 对象。

    Returns void

  • 将 Rectangle 对象的所有属性设置为 0。

    Returns void

  • 生成并返回一个字符串,该字符串列出 Rectangle 对象的水平位置和垂直位置以及高度和宽度。

    Returns string

    一个字符串,它列出了 Rectangle 对象的下列各个属性的值:x、y、width 和 height。

  • 通过填充两个矩形之间的水平和垂直空间,将这两个矩形组合在一起以创建一个新的 Rectangle 对象。

    Parameters

    • toUnion: Rectangle

      要添加到此 Rectangle 对象的 Rectangle 对象。

    Returns Rectangle

    充当两个矩形的联合的新 Rectangle 对象。

Generated using TypeDoc