Class: Rect

Rectangular region

Constructors

• constructor

Properties

• x
• y
• w
• h

Accessors

• width
• height

Methods

• pointInRect
• clone
• copyFrom
• copyTo
• inner
• equal
• equalArea
• equalInnerArea
• innerArea
• setTo

Constructors

constructor

• new Rect(x?, y?, width?, height?): Rect

Creates a new rectangular area object

Parameters

Name	Type	Default value	Description
x	number	0	The x-coordinate of the rectangle
y	number	0	The y coordinate of the rectangle
width	number	0	Width of a rectangle
height	number	0	Height of rectangle

Returns

Rect

Defined in

src/math/Rect.ts:34

Properties

x

• x: number

The x-coordinate of the rectangle

Defined in

src/math/Rect.ts:10

---

y

• y: number

The y-coordinate of the rectangle

Defined in

src/math/Rect.ts:15

---

w

• w: number

Width of a rectangle

Defined in

src/math/Rect.ts:20

---

h

• h: number

Height of rectangle

Defined in

src/math/Rect.ts:25

Accessors

width

• get width(): number

Width of a rectangle

Returns

number

Defined in

src/math/Rect.ts:44

• set width(v): void

Parameters

Name	Type
v	number

Returns

void

Defined in

src/math/Rect.ts:48

---

height

• get height(): number

Height of rectangle

Returns

number

Defined in

src/math/Rect.ts:55

• set height(v): void

Parameters

Name	Type
v	number

Returns

void

Defined in

src/math/Rect.ts:59

Methods

pointInRect

▸ pointInRect(x, y, lt_x, lt_y, rb_x, rb_y): boolean

Whether the point is within the specified area

Parameters

Name	Type	Description
x	number	x value of point
y	number	y value of point
lt_x	number	The x value in the upper left corner
lt_y	number	The y value in the upper left corner
rb_x	number	The x value in the lower right corner
rb_y	number	The y value in the lower right corner

Returns

boolean

Defined in

src/math/Rect.ts:73

---

clone

▸ clone(): Rect

Returns a new rectangular area object with the same properties as the current rectangular area

Returns

Rect

Defined in

src/math/Rect.ts:85

---

copyFrom

▸ copyFrom(rect): void

Copy the properties of the source object to this object

Parameters

Name	Type
rect	Rect

Returns

void

Defined in

src/math/Rect.ts:94

---

copyTo

▸ copyTo(rect): void

Copy the properties of this object to the target object

Parameters

Name	Type
rect	Rect

Returns

void

Defined in

src/math/Rect.ts:106

---

inner

▸ inner(x, y): boolean

Whether the point is in this area

Parameters

Name	Type	Description
x	number	x value of point
y	number	y value of point

Returns

boolean

Defined in

src/math/Rect.ts:116

---

equal

▸ equal(rectangle): boolean

Whether the current rectangle is equal to the target rectangle

Parameters

Name	Type	Description
rectangle	Rect	Target rectangle

Returns

boolean

Defined in

src/math/Rect.ts:128

---

equalArea

▸ equalArea(x, y, width, height): boolean

Whether the current rectangle is equal to the target rectangle

Parameters

Name	Type	Description
x	number	The x value of the rectangle
y	number	The y value of the rectangle
width	number	Rectangle width
height	number	Rectangular height

Returns

boolean

Defined in

src/math/Rect.ts:140

---

equalInnerArea

▸ equalInnerArea(source): boolean

Whether this rectangle overlaps with the target object

Parameters

Name	Type	Description
source	Rect	Source object

Returns

boolean

Defined in

src/math/Rect.ts:149

---

innerArea

▸ innerArea(source, target): Rect

Returns the overlap of two rectangles

Parameters

Name	Type	Description
source	Rect	source object
target	Rect	target object

Returns

Rect

Defined in

src/math/Rect.ts:174

---

setTo

▸ setTo(x, y, width, height): void

Sets the properties of the rectangle

Parameters

Name	Type	Description
x	number	x value
y	number	y value
width	number	Rectangle width
height	number	Rectangular height

Returns

void

Defined in

src/math/Rect.ts:213