Rectangle

.Geom. Rectangle

封装一个2D矩形,该矩形由左上角的角点定义,并在x(宽度)和y(高度)方向延伸

Constructor

new Rectangle(xopt, yopt, widthopt, heightopt)

Since:
  • 3.0.0
Parameters:
Name Type Attributes Default Description
x number <optional>
0 矩形左上角的X坐标.
y number <optional>
0 矩形左上角的Y坐标.
width number <optional>
0 矩形的宽度.
height number <optional>
0 矩形的高度.

Members

bottom :number

Since:
  • 3.0.0
y和高度属性的总和. 更改矩形对象的底部属性不会影响x,y和宽度属性,但会更改高度属性.
Type:
  • number

centerX :number

Since:
  • 3.0.0
矩形中心的x坐标.
Type:
  • number

centerY :number

Since:
  • 3.0.0
矩形中心的y坐标.
Type:
  • number

height :number

Since:
  • 3.0.0
Default Value:
  • 0
矩形的高度,即.其顶面(由 `y` 定义)和底面之间的距离.
Type:
  • number

left :number

Since:
  • 3.0.0
矩形左侧的x坐标. 更改矩形对象的左侧属性对y和高度属性没有影响.但是,它确实会影响width属性,而更改x值不会影响width属性.
Type:
  • number
Since:
  • 3.0.0
x和宽度属性的总和. 更改矩形对象的右属性对x,y和高度属性没有影响,但是会影响宽度属性.
Type:
  • number

top :number

Since:
  • 3.0.0
矩形顶部的y坐标.更改矩形对象的顶部属性对x和宽度属性没有影响. 但是,它确实会影响高度属性,而更改y值不会影响高度属性.
Type:
  • number

(readonly) type :number

Since:
  • 3.19.0
此对象的几何常量类型: `GEOM_CONST.RECTANGLE` . 用于快速类型比较.
Type:
  • number

width :number

Since:
  • 3.0.0
Default Value:
  • 0
矩形的宽度,即.其左侧(由 `x` 定义)与其右侧之间的距离.
Type:
  • number

x :number

Since:
  • 3.0.0
Default Value:
  • 0
矩形左上角的X坐标.
Type:
  • number

y :number

Since:
  • 3.0.0
Default Value:
  • 0
矩形左上角的Y坐标.
Type:
  • number

Methods

(static) Area(rect) → {number}

Since:
  • 3.0.0
计算给定矩形对象的面积.
Parameters:
Name Type Description
rect Phaser.Geom.Rectangle 要计算其面积的矩形.
Returns:
矩形对象的区域.
Type
number

(static) Ceil(rect) → {Phaser.Geom.Rectangle}

Since:
  • 3.0.0
将矩形的位置向上舍入到大于或等于每个当前坐标的最小整数.
Parameters:
Name Type Description
rect Phaser.Geom.Rectangle 要调整的矩形.
Returns:
调整后的矩形.
Type
Phaser.Geom.Rectangle

(static) CeilAll(rect) → {Phaser.Geom.Rectangle}

Since:
  • 3.0.0
将矩形的位置和大小向上舍入到大于或等于每个相应值的最小整数.
Parameters:
Name Type Description
rect Phaser.Geom.Rectangle 要修改的矩形.
Returns:
修改后的矩形.
Type
Phaser.Geom.Rectangle

(static) CenterOn(rect, x, y) → {Phaser.Geom.Rectangle}

Since:
  • 3.0.0
移动矩形的左上角,使其中心位于给定的坐标.
Parameters:
Name Type Description
rect Phaser.Geom.Rectangle 要居中的矩形.
x number 矩形中心的X坐标.
y number 矩形中心的Y坐标.
Returns:
居中的矩形.
Type
Phaser.Geom.Rectangle

(static) Clone(source) → {Phaser.Geom.Rectangle}

Since:
  • 3.0.0
创建一个与给定矩形相同的新矩形.
Parameters:
Name Type Description
source Phaser.Geom.Rectangle 要克隆的矩形.
Returns:
新创建的矩形,它独立于给定的矩形.
Type
Phaser.Geom.Rectangle

(static) Contains(rect, x, y) → {boolean}

Since:
  • 3.0.0
检查给定点是否在矩形的边界内.
Parameters:
Name Type Description
rect Phaser.Geom.Rectangle 要检查的矩形.
x number 要检查的点的X坐标.
y number 要检查的点的Y坐标.
Returns:
如果该点在矩形的边界内,则为 `true` ,否则为 `false` .
Type
boolean

(static) ContainsPoint(rect, point) → {boolean}

Since:
  • 3.0.0
确定指定点是否包含在此矩形对象定义的矩形区域内.
Parameters:
Name Type Description
rect Phaser.Geom.Rectangle 矩形对象.
point Phaser.Geom.Point 要检查的点对象.可以是相位点对象或任何具有x和y值的对象.
Returns:
如果矩形对象包含指定点,则值为true,否则为false.
Type
boolean

(static) ContainsRect(rectA, rectB) → {boolean}

Since:
  • 3.0.0
测试一个矩形是否完全包含另一个矩形.
Parameters:
Name Type Description
rectA Phaser.Geom.Rectangle 第一个矩形.
rectB Phaser.Geom.Rectangle 第二个长方形.
Returns:
仅当rectA完全包含rectB时为True.
Type
boolean

(static) CopyFrom(source, dest) → {Phaser.Geom.Rectangle}

Since:
  • 3.0.0
将一个矩形的值复制到目标矩形.
Parameters:
Name Type Description
source Phaser.Geom.Rectangle 要从中复制值的源矩形.
dest Phaser.Geom.Rectangle 要将值复制到的目标矩形.
Returns:
目标矩形.
Type
Phaser.Geom.Rectangle

(static) Decompose(rect, outopt) → {array}

Since:
  • 3.0.0
为矩形的每个角创建一个点数组 如果指定了数组,每个点对象将被添加到数组的末尾,否则将创建一个新数组.
Parameters:
Name Type Attributes Description
rect Phaser.Geom.Rectangle 要分解的矩形对象.
out array <optional>
如果提供,每个点都将被添加到该数组中.
Returns:
将返回您指定的数组或包含矩形点的新数组.
Type
array

(static) Equals(rect, toCompare) → {boolean}

Since:
  • 3.0.0
比较两个矩形的 `x` , `y` , `width` 和 `height` 属性.
Parameters:
Name Type Description
rect Phaser.Geom.Rectangle Rectangle A
toCompare Phaser.Geom.Rectangle Rectangle B
Returns:
如果矩形的属性完全匹配,则为 `true` ,否则为 `false` .
Type
boolean

(static) FitInside(target, source) → {Phaser.Geom.Rectangle}

Since:
  • 3.0.0
调整目标矩形,更改其宽度,高度和位置, 以便它适合源矩形的区域,同时保持其原始形状 长宽比. 与 `FitOutside` 功能不同,源区域内可能有一些未覆盖的空间.
Parameters:
Name Type Description
target Phaser.Geom.Rectangle 要调整的目标矩形.
source Phaser.Geom.Rectangle 包围目标的源矩形.
Returns:
修改后的目标矩形实例.
Type
Phaser.Geom.Rectangle

(static) FitOutside(target, source) → {Phaser.Geom.Rectangle}

Since:
  • 3.0.0
调整目标矩形,更改其宽度,高度和位置, 以便它完全覆盖源矩形的区域,同时保持其原始形状 长宽比. 与 `FitInside` 函数不同,目标矩形可能比源矩形延伸得更远.
Parameters:
Name Type Description
target Phaser.Geom.Rectangle 要调整的目标矩形.
source Phaser.Geom.Rectangle 用于包围目标的源矩形.
Returns:
修改后的目标矩形实例.
Type
Phaser.Geom.Rectangle

(static) Floor(rect) → {Phaser.Geom.Rectangle}

Since:
  • 3.0.0
将给定矩形的左上角X和Y坐标向下舍入到小于或等于它们的最大整数
Parameters:
Name Type Description
rect Phaser.Geom.Rectangle 该矩形以楼层左上角的X和Y坐标表示
Returns:
传递给此函数的矩形,其坐标已被绘制.
Type
Phaser.Geom.Rectangle

(static) FloorAll(rect) → {Phaser.Geom.Rectangle}

Since:
  • 3.0.0
将矩形的位置和大小向下舍入到小于或等于每个当前坐标或尺寸的最大整数.
Parameters:
Name Type Description
rect Phaser.Geom.Rectangle 要调整的矩形.
Returns:
调整后的矩形.
Type
Phaser.Geom.Rectangle

(static) FromPoints(points, outopt) → {Phaser.Geom.Rectangle}

Since:
  • 3.0.0
构造新的矩形或重新定位和调整现有矩形的大小,以便所有给定点都在其边界上或边界内.
Parameters:
Name Type Attributes Description
points array 应被矩形包围的点数组(两个元素对应于X和Y坐标的数组或具有公共属性 `x` 和 `y` 的对象).
out Phaser.Geom.Rectangle <optional>
要调整的可选矩形.
Returns:
调整后的矩形,或新的矩形,如果没有提供.
Type
Phaser.Geom.Rectangle

(static) FromXY(x1, y1, x2, y2, outopt) → {Phaser.Geom.Rectangle}

Since:
  • 3.23.0
创建包含两个坐标对的最小矩形.
Parameters:
Name Type Attributes Description
x1 number 第一个点的X坐标.
y1 number 第一个点的Y坐标.
x2 number 第二个点的X坐标.
y2 number 第二个点的Y坐标.
out Phaser.Geom.Rectangle <optional>
要调整的可选矩形.
Returns:
调整后的矩形,或新的矩形,如果没有提供.
Type
Phaser.Geom.Rectangle

(static) GetAspectRatio(rect) → {number}

Since:
  • 3.0.0
计算矩形的宽高比.
Parameters:
Name Type Description
rect