Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Rectangle

矩形数学类

Hierarchy

  • Rectangle
    • Rectangle

Index

Constructors

constructor

  • new Rectangle(x?: number, y?: number, width?: number, height?: number): Rectangle
  • 创建一个 Rectangle 对象。

    Parameters

    • x: number = 0

      矩形左上角的 X 轴坐标。

    • y: number = 0

      矩形左上角的 Y 轴坐标。

    • width: number = 0

      矩形的宽度。

    • height: number = 0

      矩形的高度。

    Returns Rectangle

Properties

height

height: number

矩形的高度。

width

width: number

矩形的宽度。

x

x: number

矩形左上角的 X 轴坐标。

y

y: number

矩形左上角的 Y 轴坐标。

Static TEMP

TEMP: Rectangle

全局临时的矩形区域,此对象用于全局复用,以减少对象创建

Accessors

bottom

  • get bottom(): number
  • 此矩形底端的 Y 轴坐标。y 和 height 属性的和。

    Returns number

right

  • get right(): number
  • 此矩形右侧的 X 轴坐标。 x 和 width 属性的和。

    Returns number

Methods

addPoint

  • addPoint(x: number, y: number): Rectangle
  • 为当前矩形对象加一个点,以使当前矩形扩展为包含当前矩形和此点的最小矩形。

    此方法会修改本对象。

    Parameters

    • x: number

      点的 X 坐标。

    • y: number

      点的 Y 坐标。

    Returns Rectangle

    返回此 Rectangle 对象。

clone

  • clone(out?: null | Rectangle): Rectangle
  • 返回一个 Rectangle 对象,其 x、y、width 和 height 属性的值与当前 Rectangle 对象的对应值相同。

    Parameters

    • Optional out: null | Rectangle

      (可选)用于存储结果的矩形对象。如果为空,则创建一个新的。建议:尽量复用对象,减少对象创建消耗。。Rectangle.TEMP对象用于对象复用。

    Returns Rectangle

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

contains

  • contains(x: number, y: number): boolean
  • 确定由此 Rectangle 对象定义的矩形区域内是否包含指定的点。

    Parameters

    • x: number

      点的 X 轴坐标值(水平位置)。

    • y: number

      点的 Y 轴坐标值(垂直位置)。

    Returns boolean

    如果 Rectangle 对象包含指定的点,则值为 true;否则为 false。

copyFrom

  • copyFrom(source: Rectangle): Rectangle
  • 复制 source 对象的属性值到此矩形对象中。

    Parameters

    • source: Rectangle

    Returns Rectangle

    返回属性值修改后的矩形对象本身。

equals

  • equals(rect: Rectangle): boolean
  • 检测传入的 Rectangle 对象的属性是否与当前 Rectangle 对象的属性 x、y、width、height 属性值都相等。

    Parameters

    • rect: Rectangle

      待比较的 Rectangle 对象。

    Returns boolean

    如果判断的属性都相等,则返回 true ,否则返回 false。

intersection

  • intersection(rect: Rectangle, out?: null | Rectangle): null | Rectangle
  • 如果在 rect 参数中指定的 Rectangle 对象与此 Rectangle 对象相交,则返回交集区域作为 Rectangle 对象。如果矩形不相交,则此方法返回null。

    Parameters

    • rect: Rectangle

      待比较的矩形区域。

    • Optional out: null | Rectangle

      (可选)待输出的矩形区域。如果为空则创建一个新的。建议:尽量复用对象,减少对象创建消耗。

    Returns null | Rectangle

    返回相交的矩形区域对象。

intersects

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

    Parameters

    • rect: Rectangle

      Rectangle 对象。

    Returns boolean

    如果传入的矩形对象与此对象相交,则返回 true 值,否则返回 false。

isEmpty

  • isEmpty(): boolean
  • 确定此 Rectangle 对象是否为空。

    Returns boolean

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

recover

  • recover(): void
  • 回收

    Returns void

reset

  • reset(): Rectangle
  • 重置

    Returns Rectangle

setTo

  • setTo(x: number, y: number, width: number, height: number): Rectangle
  • 将 Rectangle 的属性设置为指定值。

    Parameters

    • x: number

      x 矩形左上角的 X 轴坐标。

    • y: number

      x 矩形左上角的 Y 轴坐标。

    • width: number

      矩形的宽度。

    • height: number

      矩形的高。

    Returns Rectangle

    返回属性值修改后的矩形对象本身。

toString

  • toString(): string
  • 当前 Rectangle 对象的水平位置 x 和垂直位置 y 以及高度 width 和宽度 height 以逗号连接成的字符串。

    Returns string

union

  • union(source: Rectangle, out?: null | Rectangle): Rectangle
  • 矩形联合,通过填充两个矩形之间的水平和垂直空间,将这两个矩形组合在一起以创建一个新的 Rectangle 对象。

    注意:union() 方法忽略高度或宽度值为 0 的矩形,如:var rect2:Rectangle = new Rectangle(300,300,50,0);

    Parameters

    • source: Rectangle
    • Optional out: null | Rectangle

      用于存储输出结果的矩形对象。如果为空,则创建一个新的。建议:尽量复用对象,减少对象创建消耗。Rectangle.TEMP对象用于对象复用。

    Returns Rectangle

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

Static create

  • create(): Rectangle
  • 创建

    Returns Rectangle