API Reference / Rectangle
# Class: Rectangle
# Table of contents
# Constructors
# Properties
# Accessors
# Methods
# Constructors
# constructor
• Protected
new Rectangle(x?
, y?
, width?
, height?
)
# Parameters
Name | Type |
---|---|
x? | number |
y? | number |
width? | number |
height? | number |
# Defined in
geom/Rectangle.ts:10 (opens new window)
# Properties
# height
• height: number
# Defined in
geom/Rectangle.ts:8 (opens new window)
# width
• width: number
# Defined in
geom/Rectangle.ts:7 (opens new window)
# x
• x: number
# Defined in
geom/Rectangle.ts:5 (opens new window)
# y
• y: number
# Defined in
geom/Rectangle.ts:6 (opens new window)
# $pool
▪ Static
Protected
Readonly
$pool: Rectangle
[] = []
# Defined in
geom/Rectangle.ts:92 (opens new window)
# Accessors
# bottom
• get
bottom(): number
# Returns
number
# Defined in
geom/Rectangle.ts:23 (opens new window)
• set
bottom(bottom
): void
# Parameters
Name | Type |
---|---|
bottom | number |
# Returns
void
# Defined in
geom/Rectangle.ts:27 (opens new window)
# bottomRight
• get
bottomRight(): Vector
# Returns
# Defined in
geom/Rectangle.ts:57 (opens new window)
• set
bottomRight(v
): void
# Parameters
Name | Type |
---|---|
v | Vector |
# Returns
void
# Defined in
geom/Rectangle.ts:61 (opens new window)
# left
• get
left(): number
# Returns
number
# Defined in
geom/Rectangle.ts:31 (opens new window)
• set
left(left
): void
# Parameters
Name | Type |
---|---|
left | number |
# Returns
void
# Defined in
geom/Rectangle.ts:35 (opens new window)
# right
• get
right(): number
# Returns
number
# Defined in
geom/Rectangle.ts:40 (opens new window)
• set
right(right
): void
# Parameters
Name | Type |
---|---|
right | number |
# Returns
void
# Defined in
geom/Rectangle.ts:44 (opens new window)
# top
• get
top(): number
# Returns
number
# Defined in
geom/Rectangle.ts:14 (opens new window)
• set
top(top
): void
# Parameters
Name | Type |
---|---|
top | number |
# Returns
void
# Defined in
geom/Rectangle.ts:18 (opens new window)
# topLeft
• get
topLeft(): Vector
# Returns
# Defined in
geom/Rectangle.ts:48 (opens new window)
• set
topLeft(v
): void
# Parameters
Name | Type |
---|---|
v | Vector |
# Returns
void
# Defined in
geom/Rectangle.ts:52 (opens new window)
# Methods
# contains
▸ contains(v
): boolean
# Parameters
Name | Type |
---|---|
v | Vector |
# Returns
boolean
# Defined in
geom/Rectangle.ts:74 (opens new window)
▸ contains(x
, y
): boolean
# Parameters
Name | Type |
---|---|
x | number |
y | number |
# Returns
boolean
# Defined in
geom/Rectangle.ts:75 (opens new window)
# equal
▸ equal(r
): boolean
# Parameters
Name | Type |
---|---|
r | Rectangle |
# Returns
boolean
# Defined in
geom/Rectangle.ts:83 (opens new window)
# release
▸ release(): void
# Returns
void
# Defined in
geom/Rectangle.ts:88 (opens new window)
# set
▸ set(x
, y
, width
, height
): Rectangle
# Parameters
Name | Type |
---|---|
x | number |
y | number |
width | number |
height | number |
# Returns
# Defined in
geom/Rectangle.ts:66 (opens new window)
# create
▸ Static
create(x?
, y?
, width?
, height?
): Rectangle
# Parameters
Name | Type |
---|---|
x? | number |
y? | number |
width? | number |
height? | number |
# Returns
# Defined in
geom/Rectangle.ts:94 (opens new window)
# recycle
▸ Static
recycle(r
): void
# Parameters
Name | Type |
---|---|
r | Rectangle |
# Returns
void