Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Rect

轴对齐矩形。 矩形内的所有点都大于等于矩形的最小点 (xMin, yMin) 并且小于等于矩形的最大点 (xMax, yMax)。 矩形的宽度定义为 xMax - xMin;高度定义为 yMax - yMin。

Hierarchy

Index

Constructors

constructor

  • newRect(other: Rect): Rect
  • newRect(x?: undefined | number, y?: undefined | number, width?: undefined | number, height?: undefined | number): Rect
  • 构造与指定矩形相等的矩形。

    Parameters

    • other: Rect

      相比较的矩形。

    Returns Rect

  • 构造具有指定的最小值和尺寸的矩形。

    Parameters

    • Optional x: undefined | number

      矩形在 x 轴上的最小值。

    • Optional y: undefined | number

      矩形在 y 轴上的最小值。

    • Optional width: undefined | number

      矩形的宽度。

    • Optional height: undefined | number

      矩形的高度。

    Returns Rect

Properties

height

height: number

获取或设置矩形的高度。

width

width: number

获取或设置矩形的宽度。

x

x: number

获取或设置矩形最小点的 x 坐标。

y

y: number

获取或设置矩形最小点的 y 坐标。

Accessors

center

  • get center(): Vec2
  • set center(value: Vec2): void
  • 获取或设置矩形中心点的坐标。

    Returns Vec2

  • 获取或设置矩形中心点的坐标。

    Parameters

    Returns void

origin

  • get origin(): any
  • set origin(value: any): void
  • 获取或设置矩形最小点的坐标。

    Returns any

  • 获取或设置矩形最小点的坐标。

    Parameters

    • value: any

    Returns void

size

  • get size(): Size
  • set size(value: Size): void
  • 获取或设置矩形的尺寸。

    Returns Size

  • 获取或设置矩形的尺寸。

    Parameters

    Returns void

w

  • get w(): number
  • set w(val: number): void
  • Returns number

  • Parameters

    • val: number

    Returns void

xMax

  • get xMax(): number
  • set xMax(value: number): void
  • 获取或设置矩形在 x 轴上的最大值。

    Returns number

  • 获取或设置矩形在 x 轴上的最大值。

    Parameters

    • value: number

    Returns void

xMin

  • get xMin(): number
  • set xMin(value: number): void
  • 获取或设置矩形在 x 轴上的最小值。

    Returns number

  • 获取或设置矩形在 x 轴上的最小值。

    Parameters

    • value: number

    Returns void

yMax

  • get yMax(): number
  • set yMax(value: number): void
  • 获取或设置矩形在 y 轴上的最大值。

    Returns number

  • 获取或设置矩形在 y 轴上的最大值。

    Parameters

    • value: number

    Returns void

yMin

  • get yMin(): number
  • set yMin(value: number): void
  • 获取或设置矩形在 y 轴上的最小值。

    Returns number

  • 获取或设置矩形在 y 轴上的最小值。

    Parameters

    • value: number

    Returns void

z

  • get z(): number
  • set z(val: number): void
  • Returns number

  • Parameters

    • val: number

    Returns void

Methods

clone

  • 克隆当前矩形。

    Returns Rect

contains

  • contains(point: Vec2): boolean
  • 判断当前矩形是否包含指定的点。

    Parameters

    • point: Vec2

      指定的点。

    Returns boolean

    指定的点包含在矩形内则返回 true,否则返回 false

containsRect

  • containsRect(other: Rect): boolean
  • 判断当前矩形是否包含指定矩形。

    Parameters

    • other: Rect

      指定的矩形。

    Returns boolean

    指定矩形所有的点都包含在当前矩形内则返回 true,否则返回 false

equals

  • equals(other: Rect): boolean
  • 判断当前矩形是否与指定矩形相等。

    Parameters

    • other: Rect

      相比较的矩形。

    Returns boolean

    两矩阵的最小值和最大值都分别相等时返回 true;否则返回 false

intersects

  • intersects(other: Rect): boolean
  • 判断当前矩形是否与指定矩形相交。

    Parameters

    • other: Rect

      相比较的矩形。

    Returns boolean

    相交则返回 true,否则返回 false

lerp

  • lerp(to: Rect, ratio: number): this
  • 根据指定的插值比率,从当前矩形到目标矩形之间做插值。

    Parameters

    • to: Rect

      目标矩形。

    • ratio: number

      插值比率,范围为 [0,1]。

    Returns this

set

  • set(other: Rect): any
  • set(x?: undefined | number, y?: undefined | number, width?: undefined | number, height?: undefined | number): any
  • 设置当前矩形使其与指定参数的矩形相等。

    Parameters

    • other: Rect

      相比较的矩形。

    Returns any

    this

  • 设置当前矩形使其与指定参数的矩形相等。

    Parameters

    • Optional x: undefined | number

      指定矩形的 x 参数

    • Optional y: undefined | number

      指定矩形的 y 参数

    • Optional width: undefined | number

      指定矩形的 width 参数

    • Optional height: undefined | number

      指定矩形的 height 参数

    Returns any

    this

toString

  • toString(): string
  • 返回当前矩形的字符串表示。

    Returns string

    当前矩形的字符串表示。

transformMat4

  • transformMat4(mat: Mat4): this
  • 应用矩阵变换到当前矩形: 应用矩阵变换到当前矩形的最小点得到新的最小点, 将当前矩形的尺寸视为二维向量应用矩阵变换得到新的尺寸; 并将如此构成的新矩形。

    Parameters

    Returns this

Static fromMinMax

  • fromMinMax<Out, VecLike>(out: Out, v1: VecLike, v2: VecLike): Out
  • 由任意两个点创建一个矩形,目标矩形即是这两个点各向 x、y 轴作线所得到的矩形。

    Type parameters

    Parameters

    • out: Out
    • v1: VecLike

      指定的点。

    • v2: VecLike

      指定的点。

    Returns Out

    目标矩形。

Static intersection

  • intersection<Out>(out: Out, one: Out, other: Out): Out
  • 计算当前矩形与指定矩形重叠部分的矩形,将其赋值给出口矩形。

    Type parameters

    Parameters

    • out: Out

      出口矩形。

    • one: Out

      指定的一个矩形。

    • other: Out

      指定的另一个矩形。

    Returns Out

Static lerp

  • lerp<Out>(out: Out, from: Out, to: Out, ratio: number): Out
  • 根据指定的插值比率,从当前矩形到目标矩形之间做插值。

    Type parameters

    Parameters

    • out: Out

      本方法将插值结果赋值给此参数

    • from: Out

      起始矩形。

    • to: Out

      目标矩形。

    • ratio: number

      插值比率,范围为 [0,1]。

    Returns Out

Static union

  • union<Out>(out: Out, one: Out, other: Out): Out
  • 创建同时包含当前矩形和指定矩形的最小矩形,将其赋值给出口矩形。

    Type parameters

    Parameters

    • out: Out

      出口矩形。

    • one: Out

      指定的一个矩形。

    • other: Out

      指定的另一个矩形。

    Returns Out

Generated using TypeDoc