Class Circle

A circle approximated from lines, drawn clockwise.

Hierarchy (View Summary)

Polyline
- Circle

Index

Constructors

Properties

center color radius

Accessors

Methods

append arc ccArc join prepend reverse

Constructors

constructor

new Circle(
    center: Fix,
    radius: number,
    color: Color | RGB,
    segments?: number,
): Circle
Parameters
- center: Fix
  The centre of the circle.
- radius: number
  The radius of the circle, in nautical miles.
- color: Color | RGB
  The color of the circle.
- Optionalsegments: number = 360
  The number of vertices used to approximate the circle.
Returns Circle
Overrides Polyline.constructor
- Defined in src/shapes/Circle.ts:14

Properties

`Readonly`center

center: Fix

The centre of the circle.

`Readonly`color

color: Color | RGB = Polyline.Color.AIRSPACE

The color of the polyline.

`Readonly`radius

radius: number

The radius of the circle, in nautical miles.

Accessors

vertices

get vertices(): readonly Fix[]
The vertices that define this shape.

Returns readonly Fix[]
Inherited from Polyline.vertices
- Defined in src/shapes/Shape.ts:19

Methods

append

append(...vertices: Fix[]): Circle
Add vertices to the end of this shape.
Parameters
- ...vertices: Fix[]
  Vertices to add.
Returns Circle
Inherited from Polyline.append
- Defined in src/shapes/Shape.ts:38

arc

arc(start: number, end: number): Polyline
Get an arc from the circle.
Parameters
- start: number
  Bearing in degrees from true north where the arc starts.
- end: number
  Bearing in degrees from true north where the arc ends.
Returns Polyline
- Defined in src/shapes/Circle.ts:34
arc(start: Fix, end: Fix): Polyline
Get an arc from the circle.
Parameters
- start: Fix
  The fix to determine the start bearing of the arc.
- end: Fix
  The fix to determine the end bearing of the arc.
Returns Polyline
- Defined in src/shapes/Circle.ts:42

ccArc

ccArc(start: number, end: number): Polyline
Get an anti-clockwise arc from the circle.
Parameters
- start: number
  Bearing in degrees from true north where the arc starts.
- end: number
  Bearing in degrees from true north where the arc ends.
Returns Polyline
- Defined in src/shapes/Circle.ts:73
ccArc(start: Fix, end: Fix): Polyline
Get an anti-clockwise arc from the circle.
Parameters
- start: Fix
  The fix to determine the start bearing of the arc.
- end: Fix
  The fix to determine the end bearing of the arc.
Returns Polyline
- Defined in src/shapes/Circle.ts:81

join

join(shape: Shape): Circle
Join another shape to the end of this shape.
Parameters
- shape: Shape
  The shape to join.
Returns Circle
Inherited from Polyline.join
- Defined in src/shapes/Shape.ts:48

prepend

prepend(...vertices: Fix[]): Circle
Add vertices to the beginning of this shape.
Parameters
- ...vertices: Fix[]
  Vertices to add.
Returns Circle
Inherited from Polyline.prepend
- Defined in src/shapes/Shape.ts:28

reverse

reverse(): Circle
Reverse the order of the vertices in this shape.

Returns Circle
Inherited from Polyline.reverse
- Defined in src/shapes/Shape.ts:56