Class Circle`Beta`

A class for Circles

Index

Constructors

Accessors

area center circumference radius x y

Methods

collideCircle collidePoint collideRect collideX collideXY collideY copy equals from rotate toString from

Constructors

constructor

new Circle(center: PointArray | Point, radius: number): Circle
Beta
The constructor of the Circle class
Parameters
- center: PointArray | Point
  the center Point of the Circle
- radius: number
  the radius of the Circle
Returns Circle
- Defined in Circle.class.ts:32

Accessors

area

get area(): number
Beta
Calculates the area of the Circle

Returns number
the area
- Defined in Circle.class.ts:229

center

get center(): Point
Beta
The center of the Circle

Returns Point
- Defined in Circle.class.ts:77
set center(point: PointArray | Point): void
Beta
Parameters
- point: PointArray | Point
Returns void
- Defined in Circle.class.ts:80

circumference

get circumference(): number
Beta
Calculates the circumference of the Circle

Returns number
the circumference
- Defined in Circle.class.ts:221

radius

get radius(): number
Beta
The radius of the Circle

Returns number
- Defined in Circle.class.ts:87
set radius(radius: number): void
Beta
Parameters
- radius: number
Returns void
- Defined in Circle.class.ts:90

x

get x(): number
Beta
The x coordinate of the center of the Circle

Returns number
- Defined in Circle.class.ts:57
set x(x: number): void
Beta
Parameters
- x: number
Returns void
- Defined in Circle.class.ts:60

y

get y(): number
Beta
The y coordinate of the center of the Circle

Returns number
- Defined in Circle.class.ts:67
set y(y: number): void
Beta
Parameters
- y: number
Returns void
- Defined in Circle.class.ts:70

Methods

collideCircle

collideCircle(other: Circle): boolean
Alpha
Checks if two Circles collide
Parameters
- other: Circle
  another Circle
Returns boolean
if the Circles collide
- Defined in Circle.class.ts:186

collidePoint

collidePoint(point: Point): boolean
Beta
Checks if the Circle collides with a given Point
Parameters
- point: Point
  a Point
Returns boolean
true or false
- Defined in Circle.class.ts:198

collideRect

collideRect(rect: Rect): boolean
Beta
Checks if the Circle collides with a given Rect
Parameters
- rect: Rect
  a Rect
Returns boolean
true or false
- Defined in Circle.class.ts:174

collideX

collideX(x: number): boolean
Beta
Checks if an x coordinate crosses the Circle
Parameters
- x: number
  an x coordinate
Returns boolean
true or false
- Defined in Circle.class.ts:99

collideXY

collideXY(x: number, y: number): boolean
Beta
Checks if an x, y coordinate touches the Circle
Parameters
- x: number
  the x coordinate to check
- y: number
  the y coordinate to check
Returns boolean
true or false
- Defined in Circle.class.ts:123

collideY

collideY(y: number): boolean
Beta
Checks if an y coordinate crosses the Circle
Parameters
- y: number
  an y coordinate
Returns boolean
true or false
- Defined in Circle.class.ts:109

copy

copy(): Circle
Beta
Returns Circle
a copy of the Circle
- Defined in Circle.class.ts:50

equals

equals(other: Circle): boolean
Beta
Parameters
- other: Circle
  the other Circle
Returns boolean
if the Circle is equal to another Circle
- Defined in Circle.class.ts:244

from

from(other: Circle): void
Beta
Updates the Circle to equal the given Circle
Parameters
- other: Circle
  the Circle to copy
Returns void
- Defined in Circle.class.ts:43

rotate

rotate(theta: number, origin?: Point): void
Alpha
Rotates the circle by theta around a given origin
Parameters
- theta: number
  the amount in radians to rotate
- origin: Point = ...
  the origin to rotate around (default: (0, 0))
Returns void
- Defined in Circle.class.ts:213

toString

toString(): string
Beta
Returns string
a string representation of the Circle
- Defined in Circle.class.ts:236

`Static`from

from(other: Circle): Circle
Beta
Constructs a new Circle from a given Circle
Parameters
- other: Circle
  Circle to copy
Returns Circle
the new Circle
- Defined in Circle.class.ts:22