import {Rectangle} from 'shapez.io/js/core/rectangle.js'

public class | source

Rectangle

You can directly use an instance of this class. FULL_CLIP_RECT

Static Method Summary

Static Public Methods
public static	fromSquare(x: number, y: number, size: number): * Constructs a new square rectangle
public static	fromTRBL(top: number, right: number, bottom: number, left: number): * Creates a rectangle from top right bottom and left offsets
public static	fromTwoPoints(p1: Vector, p2: Vector): *
public static	intersects(a: Rectangle, b: Rectangle): * Returns if a intersects b

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	h: *
public	w: *
public	x: *
public	y: *

Method Summary

Public Methods
public	allScaled(factor: number): * Scales every parameter (w, h, x, y) by the given factor.
public	bottom(): number
public	bottomRight(): Vector Returns the bottom left point
public	clone(): Rectangle Copies this instance
public	containsCircle(x: number, y: number, radius: number): boolean Returns if the rectangle contains the given circle at (x, y) with the radius (radius)
public	containsPoint(x: number, y: number): boolean Returns if hte rectangle contains the given point
public	containsRect(rect: Rectangle): boolean Returns if the given rectangle is contained
public	containsRect4Params(x: number, y: number, w: number, h: number): boolean Returns if this rectangle contains the other rectangle specified by the parameters
public	equalsEpsilon(other: Rectangle, epsilon: number): * Returns if this rectangle is equal to the other while taking an epsilon into account
public	expandedInAllDirections(amount: number): Rectangle Expands the rectangle in all directions
public	getCenter(): Vector Returns the center of the rect
public	getIntersection(rect: Rectangle): Rectangle \| null Returns the shared area with another rectangle, or null if there is no intersection
public	getUnion(rect: Rectangle): * Returns the union of this rectangle with another
public	isEmpty(): boolean Returns if this rectangle is empty
public	left(): number
public	moveBy(x: number, y: number) Moves the rectangle by the given parameters
public	moveByVector(vec: Vector) Moves the rectangle by the given vector
public	right(): number
public	setBottom(bottom: number) Sets the bottom side of the rect without moving it
public	setLeft(left: number) Sets the left side of the rect without scaling it
public	setRight(right: number) Sets the right side of the rect without moving it
public	setTop(top: number) Sets the top side of the rect without scaling it
public	toCompareableString(): * Good for caching stuff
public	toString(): * Good for printing stuff
public	toTileCullRectangle(): Rectangle Returns a new rectangle in tile space which includes all tiles which are visible in this rect
public	top(): number
public	topLeft(): Vector Returns the top left point
public	trbl(): [number, number, number, number] Returns Top, Right, Bottom, Left

Static Public Methods

public static fromSquare(x: number, y: number, size: number): * source

Constructs a new square rectangle

Params:

Name	Type	Attribute	Description
x	number
y	number
size	number

Return:

public static fromTRBL(top: number, right: number, bottom: number, left: number): * source

Creates a rectangle from top right bottom and left offsets

Params:

Name	Type	Attribute	Description
top	number
right	number
bottom	number
left	number

Return:

public static fromTwoPoints(p1: Vector, p2: Vector): * source

Params:

Name	Type	Attribute	Description
p1	Vector
p2	Vector

Return:

public static intersects(a: Rectangle, b: Rectangle): * source

Returns if a intersects b

Params:

Name	Type	Attribute	Description
a	Rectangle
b	Rectangle

Return:

Public Constructors

public constructor() source

Public Members

public h: * source

public w: * source

public x: * source

public y: * source

Public Methods

public allScaled(factor: number): * source

Scales every parameter (w, h, x, y) by the given factor. Useful to transform from world to tile space and vice versa

Params:

Name	Type	Attribute	Description
factor	number

Return:

public bottom(): number source

Return:

number

public bottomRight(): Vector source

Returns the bottom left point

Return:

Vector

public clone(): Rectangle source

Copies this instance

Return:

Rectangle

public containsCircle(x: number, y: number, radius: number): boolean source

Returns if the rectangle contains the given circle at (x, y) with the radius (radius)

Params:

Name	Type	Attribute	Description
x	number
y	number
radius	number

Return:

boolean

public containsPoint(x: number, y: number): boolean source

Returns if hte rectangle contains the given point

Params:

Name	Type	Attribute	Description
x	number
y	number

Return:

boolean

public containsRect(rect: Rectangle): boolean source

Returns if the given rectangle is contained

Params:

Name	Type	Attribute	Description
rect	Rectangle

Return:

boolean

public containsRect4Params(x: number, y: number, w: number, h: number): boolean source

Returns if this rectangle contains the other rectangle specified by the parameters

Params:

Name	Type	Attribute	Description
x	number
y	number
w	number
h	number

Return:

boolean

public equalsEpsilon(other: Rectangle, epsilon: number): * source

Returns if this rectangle is equal to the other while taking an epsilon into account

Params:

Name	Type	Attribute	Description
other	Rectangle
epsilon	number

Return:

public expandedInAllDirections(amount: number): Rectangle source

Expands the rectangle in all directions

Params:

Name	Type	Attribute	Description
amount	number

Return:

Rectangle

new rectangle

public getCenter(): Vector source

Returns the center of the rect

Return:

Vector

public getIntersection(rect: Rectangle): Rectangle | null source

Returns the shared area with another rectangle, or null if there is no intersection

Params:

Name	Type	Attribute	Description
rect	Rectangle

Return:

Rectangle | null

public getUnion(rect: Rectangle): * source

Returns the union of this rectangle with another

Params:

Name	Type	Attribute	Description
rect	Rectangle

Return:

public isEmpty(): boolean source

Returns if this rectangle is empty

Return:

boolean

public left(): number source

Return:

number

public moveBy(x: number, y: number) source

Moves the rectangle by the given parameters

Params:

Name	Type	Attribute	Description
x	number
y	number

public moveByVector(vec: Vector) source

Moves the rectangle by the given vector

Params:

Name	Type	Attribute	Description
vec	Vector

public right(): number source

Return:

number

public setBottom(bottom: number) source

Sets the bottom side of the rect without moving it

Params:

Name	Type	Attribute	Description
bottom	number

public setLeft(left: number) source

Sets the left side of the rect without scaling it

Params:

Name	Type	Attribute	Description
left	number

public setRight(right: number) source

Sets the right side of the rect without moving it

Params:

Name	Type	Attribute	Description
right	number

public setTop(top: number) source

Sets the top side of the rect without scaling it

Params:

Name	Type	Attribute	Description
top	number

public toCompareableString(): * source

Good for caching stuff

Return:

public toString(): * source

Good for printing stuff

Return:

public toTileCullRectangle(): Rectangle source

Returns a new rectangle in tile space which includes all tiles which are visible in this rect

Return:

Rectangle

public top(): number source

Return:

number

public topLeft(): Vector source

Returns the top left point

Return:

Vector

public trbl(): [number, number, number, number] source

Returns Top, Right, Bottom, Left

Return:

[number, number, number, number]