Class Rect

Hierarchy

Rect

Index

Constructors

constructor

Properties

h
w
x
y

Accessors

Methods

Constructors

constructor

new Rect(x: number, y: number, w: number, h: number): Rect

- Defined in rect.ts:15
Parameters
- x: number
  
  left coordinate
- y: number
  
  top coordinate
- w: number
  
  width of the rectangle
- h: number
  
  height of the rectangle
Returns Rect

Properties

h

h: number

w

w: number

x

x: number

y

y: number

Accessors

bottom

get bottom(): number
set bottom(y: number): void

- Defined in rect.ts:141
Bottom coordinate

Returns number
- Defined in rect.ts:145
Bottom coordinate

Parameters
- y: number
Returns void

bottomleft

get bottomleft(): Vec2
set bottomleft(__namedParameters: Vec2): void

- Defined in rect.ts:70
Bottom left corner coordinates Do not set the components directly, it would not update the rectangle.

Returns Vec2
- Defined in rect.ts:74
Bottom left corner coordinates Do not set the components directly, it would not update the rectangle.

Parameters
- __namedParameters: Vec2
Returns void

bottomright

get bottomright(): Vec2
set bottomright(__namedParameters: Vec2): void

- Defined in rect.ts:83
Bottom right corner coordinates Do not set the components directly, it would not update the rectangle.

Returns Vec2
- Defined in rect.ts:87
Bottom right corner coordinates Do not set the components directly, it would not update the rectangle.

Parameters
- __namedParameters: Vec2
Returns void

center

get center(): Vec2
set center(__namedParameters: Vec2): void

- Defined in rect.ts:96
Center coordinates Do not set the components directly, it would not update the rectangle.

Returns Vec2
- Defined in rect.ts:100
Center coordinates Do not set the components directly, it would not update the rectangle.

Parameters
- __namedParameters: Vec2
Returns void

left

get left(): number
set left(x: number): void

- Defined in rect.ts:108
Left coordinate

Returns number
- Defined in rect.ts:112
Left coordinate

Parameters
- x: number
Returns void

right

get right(): number
set right(x: number): void

- Defined in rect.ts:119
right coordinate

Returns number
- Defined in rect.ts:123
right coordinate

Parameters
- x: number
Returns void

size

get size(): Vec2
set size(__namedParameters: Vec2): void

- Defined in rect.ts:154
Size as a vector. Setting this with shrink or grow the rectangle from top left corner. Do not set the components directly, it would not update the rectangle.

Returns Vec2
- Defined in rect.ts:158
Size as a vector. Setting this with shrink or grow the rectangle from top left corner. Do not set the components directly, it would not update the rectangle.

Parameters
- __namedParameters: Vec2
Returns void

top

get top(): number
set top(y: number): void

- Defined in rect.ts:130
Top coordinate

Returns number
- Defined in rect.ts:134
Top coordinate

Parameters
- y: number
Returns void

topleft

get topleft(): Vec2
set topleft(__namedParameters: Vec2): void

- Defined in rect.ts:44
Top left corner coordinates Do not set the components directly, it would not update the rectangle.

Returns Vec2
- Defined in rect.ts:48
Top left corner coordinates Do not set the components directly, it would not update the rectangle.

Parameters
- __namedParameters: Vec2
Returns void

topright

get topright(): Vec2
set topright(__namedParameters: Vec2): void

- Defined in rect.ts:57
Top right corner coordinates Do not set the components directly, it would not update the rectangle.

Returns Vec2
- Defined in rect.ts:61
Top right corner coordinates Do not set the components directly, it would not update the rectangle.

Parameters
- __namedParameters: Vec2
Returns void

Methods

Static from_obj

from_obj(obj: Record<string, unknown>): Rect

- Defined in rect.ts:32
Return a fresh rectangle initialized from an arbitrary object.

Parameters
- obj: Record<string, unknown>
Returns Rect

Static null

null(): Rect

- Defined in rect.ts:25
Return a fresh null rectangle (size = Vec2.null() and topright = Vec2.null())

Returns Rect

Generated using TypeDoc