Module "circle"

Index

Interfaces

Circle

Constructor Functions

from

Other Functions

Transform Functions

Constructor Functions

from

from(x: number, y: number, radius: number): Circle

- Defined in circle.ts:42
Creates a circle given the x, y coordinates of the center and its radius.

Parameters
- x: number
- y: number
- radius: number
Returns Circle

Other Functions

area

area(circle: Circle): number

- Defined in circle.ts:81
Calculates the area of circle.

Parameters
- circle: Circle
Returns number

center

center(circle: Circle): Point

- Defined in circle.ts:88
Gets the Point at the center of circle.

Parameters
- circle: Circle
Returns Point

clone

clone(circle: Circle): Circle

- Defined in circle.ts:49
Creates a copy of circle that can be modified separately.

Parameters
- circle: Circle
Returns Circle

contains

contains(circle: Circle, point: Point): boolean

- Defined in circle.ts:103
Determines whether circle contains point.

Parameters
- circle: Circle
- point: Point
Returns boolean

diameter

diameter(circle: Circle): number

- Defined in circle.ts:74
Calculates the diameter of circle.

Parameters
- circle: Circle
Returns number

equals

equals(c1: Circle, c2: Circle): boolean

- Defined in circle.ts:63
Determines whether c1 and c2 are equal.

Circles are considered equal if their center coordinates and radii are the same.

Parameters
- c1: Circle
- c2: Circle
Returns boolean

intersects

intersects(c1: Circle, c2: Circle): boolean

- Defined in circle.ts:95
Determines whether c1 and c2 intersect.

Parameters
- c1: Circle
- c2: Circle
Returns boolean

is

is(value: any): value is Circle

- Defined in circle.ts:27
Determines whether value is a Circle.

Parameters
- value: any
Returns value is Circle

Transform Functions

translate

translate(circle: Circle, vector: Vector): void

- Defined in circle.ts:115
Translates circle by vector.

This modifies the circle. Use translated if you want to create a new circle.

Parameters
- circle: Circle
- vector: Vector
Returns void

translated

translated(circle: Circle, vector: Vector): { radius: number; x: number; y: number }

- Defined in circle.ts:129
Translates a circle by a vector.

This creates a new circle. Use translate if you want to modify the circle instead.

Parameters
- circle: Circle
- vector: Vector
Returns { radius: number; x: number; y: number }

The translated circle
- radius: number
- x: number
- y: number

Generated using TypeDoc