Class Rect

Rectangle shape.

Remarks

x and y are the rectangle's origin, width and height extend along the positive x/y axes.

Implements

Index

Constructors

Properties

height width x y

Accessors

cx cy right top

Constructors

constructor

new Rect(x: number, y: number, width: number, height: number): Rect
Parameters
- x: number
  X origin.
- y: number
  Y origin.
- width: number
  Extent along positive X axis.
- height: number
  Extent along positive Y axis.
Returns Rect
- Defined in math/shapes/rect.ts:82

Properties

height

height: number

Extent along positive Y axis.

width

width: number

Extent along positive X axis.

x

x: number

X origin.

y

y: number

Y origin.

Accessors

cx

get cx(): number
Rect center x.

Returns number
Implementation of ReadonlyRect.cx
- Defined in math/shapes/rect.ts:74

cy

get cy(): number
Rect center y.

Returns number
Implementation of ReadonlyRect.cy
- Defined in math/shapes/rect.ts:78

right

get right(): number
Rect x plus width.

Returns number
Implementation of ReadonlyRect.right
- Defined in math/shapes/rect.ts:66

top

get top(): number
Rect y plus height.

Returns number
Implementation of ReadonlyRect.top
- Defined in math/shapes/rect.ts:70

Methods

asReadonly

asReadonly(): ReadonlyRect
Returns ReadonlyRect
- Defined in math/shapes/rect.ts:411

ceil

ceil(): this
Ceil this rect (floors x and y, ceils width and height).

Returns this
Self
- Defined in math/shapes/rect.ts:367

clip

clip(other: RectLike): this
Clip this rect to other.
Parameters
- other: RectLike
  Clip rect
Returns this
Self
- Defined in math/shapes/rect.ts:283

clone

clone(): Rect
Returns Rect
Implementation of ReadonlyRect.clone
- Defined in math/shapes/rect.ts:407

containsPoint

containsPoint(__namedParameters: Vec2Like): boolean
Check if this shape contains point.
Parameters
- __namedParameters: Vec2Like
  Point to check
Returns boolean
true if this shape contains the point
Implementation of ReadonlyRect.containsPoint
- Defined in math/shapes/rect.ts:335

containsRect

containsRect(other: RectLike): boolean
Check if this rect contains other.
Parameters
- other: RectLike
  Rect
Returns boolean
true if contained
Implementation of ReadonlyRect.containsRect
- Defined in math/shapes/rect.ts:323

copyCenterFrom

copyCenterFrom(vec: Vec2Like): this
Set center of this rect.
Parameters
- vec: Vec2Like
  Center vec
Returns this
Self
- Defined in math/shapes/rect.ts:141

copyFrom

copyFrom(other: RectLike): this
Parameters
- other: RectLike
Returns this
- Defined in math/shapes/rect.ts:398

copyPositionFrom

copyPositionFrom(param0: Vec2Like): this
Copy position from the given vec.
Parameters
- param0: Vec2Like
  Posiiton
Returns this
Self
- Defined in math/shapes/rect.ts:114

equals

equals(other: RectLike, epsilon?: number): boolean
Parameters
- other: RectLike
- epsilon: number = Number.EPSILON
Returns boolean
Implementation of ReadonlyRect.equals
- Defined in math/shapes/rect.ts:389

extend

extend(other: RectLike): this
Extend this rect to encompass other.
Parameters
- other: RectLike
  Other rect to extend with
Returns this
Self
- Defined in math/shapes/rect.ts:256

floor

floor(): this
Floor this rect (ceils x and y, floors width and height).

Returns this
Self
- Defined in math/shapes/rect.ts:354

intersectsRect

intersectsRect(other: RectLike): boolean
Check if this shape and rect intersect.
Parameters
- other: RectLike
Returns boolean
true if shape and rect intersect
Implementation of ReadonlyRect.intersectsRect
- Defined in math/shapes/rect.ts:311

multiplyMat

multiplyMat(mat: Mat2DLike): this
Multiply this rect by a matrix.
Parameters
- mat: Mat2DLike
  Matrix
Returns this
Self

Remarks
Projected rect will be axis-aligned.
- Defined in math/shapes/rect.ts:195

multiplyMatInverse

multiplyMatInverse(mat: Mat2DLike): this
Inversely multiply this rect by a matrix.
Parameters
- mat: Mat2DLike
  Matrix
Returns this
Self

Remarks
Projected rect will be axis-aligned.
- Defined in math/shapes/rect.ts:223

round

round(): this
Round position and extents of this rect.

Returns this
Self
- Defined in math/shapes/rect.ts:380

set

set(x: number, y: number): this
Parameters
- x: number
- y: number
Returns this
- Defined in math/shapes/rect.ts:93
set(x: number, y: number, size: number): this
Parameters
- x: number
- y: number
- size: number
Returns this
- Defined in math/shapes/rect.ts:94
set(x: number, y: number, width: number, height: number): this
Parameters
- x: number
- y: number
- width: number
- height: number
Returns this
- Defined in math/shapes/rect.ts:95

setCenter

setCenter(x: number, y?: number): this
Set center of this rect.
Parameters
- x: number
  Center x
- Optionaly: number
  Center y
Returns this
Self
- Defined in math/shapes/rect.ts:127

setFromPoints

setFromPoints(points: readonly Vec2Like[]): this
Set this rect's dimensions to a bounding box of points.
Parameters
- points: readonly Vec2Like[]
  Points to encompass
Returns this
Self
- Defined in math/shapes/rect.ts:153

toString

toString(): string
Returns a string representation of an object.

Returns string
- Defined in math/shapes/rect.ts:415

`Static`from

from(like: RectLike, centerOrigin?: boolean): Rect
Parameters
- like: RectLike
- centerOrigin: boolean = false
Returns Rect
- Defined in math/shapes/rect.ts:419

`Static`fromPoint

fromPoint(
    __namedParameters: Vec2Like,
    width: number,
    height: number,
    centerOrigin?: boolean,
): Rect
Parameters
- __namedParameters: Vec2Like
- width: number
- height: number
- centerOrigin: boolean = false
Returns Rect
- Defined in math/shapes/rect.ts:432

`Static`fromPoints

fromPoints(points: readonly Vec2Like[]): Rect
Create a bounding box rect from points.
Parameters
- points: readonly Vec2Like[]
  Points to encompass
Returns Rect
Bounding box rect

See
Rect.setFromPoints
- Defined in math/shapes/rect.ts:451

`Static`one

one(): Rect
A new instance initialized with extents of one.

Returns Rect
- Defined in math/shapes/rect.ts:465

`Static`zero

zero(): Rect
A new instance initialized to all zeroes.

Returns Rect
- Defined in math/shapes/rect.ts:458