Class: Circle

Constructor

new Circle(centre, radius)

Parameters:

Name	Type	Description
`centre`	Point2D	A Point2D representing the centre of the circle.
`radius`	number	The radius of the circle.

Source: src/math/circle.js, line 31

Classes

Circle

Methods

equals(rhs) → {boolean}

Check for equality.

Parameters:

Name	Type	Description
`rhs`	Circle	The object to compare to.

Source: src/math/circle.js, line 82

Returns:

True if both objects are equal.

Type:: boolean

getCenter() → {Point2D}

Get the centre (point) of the circle.

Source: src/math/circle.js, line 62

Returns:

The center (point) of the circle.

Type:: Point2D

getRadius() → {number}

Get the radius of the circle.

Source: src/math/circle.js, line 71

Returns:

The radius of the circle.

Type:: number

getRound() → {Array.<Array.<Array.<number>>>}

Get the rounded limits of the circle.

See: https://en.wikipedia.org/wiki/Circle#Equations.

Circle formula: x*x + y*y = r*r.

Implies: y = (+-) sqrt(r*r - x*x).

Source: src/math/circle.js, line 120

Returns:

The rounded limits: list of [x, y] pairs (min, max).

Type:: Array.<Array.<Array.<number>>>

getSurface() → {number}

Get the surface of the circle.

Source: src/math/circle.js, line 93

Returns:

The surface of the circle.

Type:: number

getWorldSurface(spacing2D) → {number}

Get the surface of the circle according to a spacing.

Parameters:

Name	Type	Description
`spacing2D`	Scalar2D	The 2D spacing.

Source: src/math/circle.js, line 104

Returns:

The surface of the circle multiplied by the given spacing or null for null spacings.

Type:: number

quantify(viewController, flags) → {object}

Quantify an circle according to view information.

Parameters:

Name	Type	Description
`viewController`	ViewController	The associated view controller.
`flags`	Array.<string>	A list of stat values to calculate.

Source: src/math/circle.js, line 156

Returns:

A quantification object.

Type:: object