Home > @esengine/ecs-framework-monorepo > Rectangle

Rectangle class

2D矩形类

表示一个轴对齐的矩形，提供矩形相关的几何运算功能： - 矩形创建和属性获取 - 包含检测（点、矩形） - 相交检测和计算 - 变换和操作

Signature:

export declare class Rectangle

Constructors

Constructor	Modifiers	Description
(constructor)(x, y, width, height)		创建矩形

Properties

Property	Modifiers	Type	Description
area	readonly	number	获取面积
bottom	readonly	number	获取下边界
bottomLeft	readonly	Vector2	获取左下角点
bottomRight	readonly	Vector2	获取右下角点
center	readonly	Vector2	获取中心点
centerX	readonly	number	获取中心X坐标
centerY	readonly	number	获取中心Y坐标
EMPTY	static readonly	Rectangle	空矩形
height		number	矩形高度
isEmpty	readonly	boolean	检查是否为空矩形
isSquare	readonly	boolean	检查是否为正方形
left	readonly	number	获取左边界
perimeter	readonly	number	获取周长
right	readonly	number	获取右边界
top	readonly	number	获取上边界
topLeft	readonly	Vector2	获取左上角点
topRight	readonly	Vector2	获取右上角点
width		number	矩形宽度
x		number	矩形左上角X坐标
y		number	矩形左上角Y坐标

Methods

Method	Modifiers	Description
clone()		克隆当前矩形
closestPointTo(point)		获取矩形上距离指定点最近的点
contains(x, y)		检查是否包含指定坐标
containsPoint(point)		检查是否包含指定点
containsRect(other)		检查是否完全包含另一个矩形
copy(other)		复制另一个矩形的值
distanceToPoint(point)		计算点到矩形的最短距离
distanceToRect(other)		计算两个矩形间的最短距离
equals(other, epsilon)		检查两个矩形是否相等
exactEquals(other)		检查两个矩形是否完全相等
fromCenter(centerX, centerY, width, height)	static	从中心点和大小创建矩形
fromPointArray(points)	static	从点数组创建包围矩形
fromPoints(point1, point2)	static	从两个点创建矩形
getVertices()		获取四个顶点
inflate(amount)		扩展矩形
inflateXY(horizontal, vertical)		扩展矩形（分别指定水平和垂直方向）
intersection(other)		计算与另一个矩形的相交矩形
intersectionArea(other)		计算相交面积
intersects(other)		检查是否与另一个矩形相交
lerp(a, b, t)	static	线性插值两个矩形
scale(scaleX, scaleY)		缩放矩形（从中心缩放）
set(x, y, width, height)		设置矩形属性
setCenter(centerX, centerY)		设置矩形中心点
setPosition(x, y)		设置矩形位置
setSize(width, height)		设置矩形大小
square(x, y, size)	static	创建正方形
toArray()		转换为数组
toObject()		转换为普通对象
toString()		转换为字符串
translate(dx, dy)		平移矩形
union(other)		计算与另一个矩形的并集矩形