Class Rect

The Rect is normally expressed as a top-left corner and a size.

Hierarchy

Rect

Index

Constructors

Properties

m_x1 m_x2 m_y1 m_y2

Accessors

bottom bottomLeft bottomRight center height left right size top topLeft topRight width x y

Methods

clone compare contains copy isNull isValid moveLeft moveRight moveTo translate translated fromPoint

Constructors

constructor

new Rect(x?, y?, width?, height?): Rect
Constructs a rect with (x, y) as its top-left corner and the given width and height.
Parameters
- x: number = 0
- y: number = 0
- width: number = 0
- height: number = 0
Returns Rect
- Defined in core/rect.ts:15

Properties

`Private` m_x1

m_x1: number

`Private` m_x2

m_x2: number

`Private` m_y1

m_y1: number

`Private` m_y2

m_y2: number

Accessors

bottom

get bottom(): number
Returns the y-coordinate of the rect's bottom edge.

Returns number
- Defined in core/rect.ts:79
set bottom(pos): void
Sets the bottom edge of the rect to the given pos.
Parameters
- pos: number
Returns void
- Defined in core/rect.ts:86

bottomLeft

get bottomLeft(): Point
Returns the position of the rect's bottom-left corner.

Returns Point
- Defined in core/rect.ts:107

bottomRight

get bottomRight(): Point
Returns the position of the rect's bottom-right corner.

Returns Point
- Defined in core/rect.ts:114

center

get center(): Point
Returns the center point of the rect.

Returns Point
- Defined in core/rect.ts:171

height

get height(): number
Returns the height of the rect.

Returns number
- Defined in core/rect.ts:164
set height(h): void
Sets the height of the rect to the given h. The bottom edge is changed, but not the top one.
Parameters
- h: number
Returns void
- Defined in core/rect.ts:157

left

get left(): number
Returns the x-coordinate of the rect's left edge. Equivalent to x.

Returns number
- Defined in core/rect.ts:37
set left(pos): void
Sets the left edge of the rect to the given pos.
Parameters
- pos: number
Returns void
- Defined in core/rect.ts:44

right

get right(): number
Returns the x-coordinate of the rect's right edge.

Returns number
- Defined in core/rect.ts:65
set right(pos): void
Sets the right edge of the rect to the given pos.
Parameters
- pos: number
Returns void
- Defined in core/rect.ts:72

size

get size(): Size
Returns the size of the rect.

Returns Size
- Defined in core/rect.ts:180

top

get top(): number
Returns the y-coordinate of the rect's top edge. Equivalent to y.

Returns number
- Defined in core/rect.ts:51
set top(pos): void
Sets the top edge of the rect to the given pos.
Parameters
- pos: number
Returns void
- Defined in core/rect.ts:58

topLeft

get topLeft(): Point
Returns the position of the rect's top-left corner.

Returns Point
- Defined in core/rect.ts:93

topRight

get topRight(): Point
Returns the position of the rect's top-right corner.

Returns Point
- Defined in core/rect.ts:100

width

get width(): number
Returns the width of the rect.

Returns number
- Defined in core/rect.ts:150
set width(w): void
Sets the width of the rect to the given w. The right edge is changed, but not the left one.
Parameters
- w: number
Returns void
- Defined in core/rect.ts:143

x

get x(): number
Returns number
- Defined in core/rect.ts:125
set x(x): void
Equivalent to left.
Parameters
- x: number
Returns void
- Defined in core/rect.ts:121

y

get y(): number
Returns number
- Defined in core/rect.ts:136
set y(y): void
Equivalent to top.
Parameters
- y: number
Returns void
- Defined in core/rect.ts:132

Methods

clone

clone(): Rect
Returns a copy of this rect.

Returns Rect
- Defined in core/rect.ts:304

compare

compare(other): boolean
Returns true if this rect and other are equal; otherwise returns false.
Parameters
- other: Rect
Returns boolean
- Defined in core/rect.ts:311

contains

contains(p, proper?): boolean
Returns true if the given p is inside or on the edge of the rect, otherwise returns false.
Parameters
- p: Point
- proper: boolean = false
  
  The default value is false. If proper is true, this function only returns true if the given p is inside the rect (i.e., not on the edge).
Returns boolean
- Defined in core/rect.ts:233

copy

copy(other): void
Copies the other rect to this rect.
Parameters
- other: Rect
Returns void
- Defined in core/rect.ts:294

isNull

isNull(): boolean
Returns true if both the width and height is 0, otherwise returns false.

Returns boolean
- Defined in core/rect.ts:280

isValid

isValid(): boolean
Returns true if the rect is valid(left <= right && top <= bottom), otherwise returns false.

Returns boolean
- Defined in core/rect.ts:287

moveLeft

moveLeft(left): void
Moves the rect horizontally, leaving the rect's left edge at the given x coordinate.
Parameters
- left: number
Returns void
- Defined in core/rect.ts:214

moveRight

moveRight(right): void
Moves the rect horizontally, leaving the rect's right edge at the given x coordinate.
Parameters
- right: number
Returns void
- Defined in core/rect.ts:223

moveTo

moveTo(x, y): void
Moves the rect, leaving the top-left corner at the given position (x, y).
Parameters
- x: number
- y: number
Returns void
- Defined in core/rect.ts:204

translate

translate(dx, dy): void
Moves dx along the x axis and dy along the y axis, relative to the current position.
Parameters
- dx: number
- dy: number
Returns void
- Defined in core/rect.ts:187

translated

translated(dx, dy): Rect
Returns a copy of the rect that is translated dx along the x axis and dy along the y axis, relative to the current position.
Parameters
- dx: number
- dy: number
Returns Rect
- Defined in core/rect.ts:197

`Static` fromPoint

fromPoint(topLeft, bottomRight): Rect
Constructs a rect with the given topLeft and bottomRight corners.
Parameters
- topLeft: Point
- bottomRight: Point
Returns Rect
- Defined in core/rect.ts:25

Generated using TypeDoc