Class Circle2d

Defines a circle in two-dimensional coordinates.

See

https://en.wikipedia.org/wiki/Circle

Hierarchy

Circle2d

Implements

IClosedShape2d

Index

Constructors

Properties

Accessors

area center diameter perimeter

Methods

contains doesIntersect getIntersectionPoints isOnEdge rotate translate getArea getPerimeter

Constructors

constructor

new Circle2d(center, radius): Circle2d
Parameters
- center: Point2d
- radius: number
Returns Circle2d
- Defined in circle2d.ts:33

Properties

`Private` _center

_center: Point2d

radius

radius: number

Gets or sets the radius.

Accessors

area

get area(): number
Gets the area of the circle.

Returns number
Implementation of IClosedShape2d.area
- Defined in circle2d.ts:62

center

get center(): Point2d
Gets the center of the circle.

Returns Point2d
- Defined in circle2d.ts:41

diameter

get diameter(): number
Gets the diameter of the circle.

Returns number
- Defined in circle2d.ts:55

perimeter

get perimeter(): number
Gets the perimeter of the circle.

Returns number
Implementation of IClosedShape2d.perimeter
- Defined in circle2d.ts:48

Methods

contains

contains(point): boolean
Checks if the given point is located inside the circle.
Parameters
- point: Point2d
  The reference point.
Returns boolean
true if the point is inside the circle.
Implementation of IClosedShape2d.contains
- Defined in circle2d.ts:102

doesIntersect

doesIntersect(shape): boolean
Checks if the current circle intersect with the given shape.
Parameters
- shape: IShape2d
  The reference shape.
Returns boolean
true it the two shapes intersect, otherwise false.
Implementation of IClosedShape2d.doesIntersect
- Defined in circle2d.ts:111

getIntersectionPoints

getIntersectionPoints(shape): Point2d[]
Get the intersection points with the given shape.
Parameters
- shape: IShape2d
  The reference shape.
Returns Point2d[]
An array of points if any intersection exist, otherwise an empty array.
Implementation of IClosedShape2d.getIntersectionPoints
- Defined in circle2d.ts:120

isOnEdge

isOnEdge(point, threshold?): boolean
Checks if the given point is on one edge of the circle.
Parameters
- point: Point2d
  The reference point.
- threshold: number = 0
  A value used as a threshold / range to check if the point is on one edge.
Returns boolean
true if the point is on edge.
Implementation of IClosedShape2d.isOnEdge
- Defined in circle2d.ts:93

rotate

rotate(angle, origin?): void
Rotates the circle by the given angle in degree, around a point.
Parameters
- angle: number
  The rotation angle.
- origin: Point2d = ...
  The origin from which the rotation is supposed to be done.
Returns void
Implementation of IClosedShape2d.rotate
- Defined in circle2d.ts:79

translate

translate(vector): void
Translates the circle using the given vector for direction.
Parameters
- vector: Vector2d
  The vector defining the direction.
Returns void
Implementation of IClosedShape2d.translate
- Defined in circle2d.ts:70

`Static` getArea

getArea(radius): number
Gets the area of a circle.
Parameters
- radius: number
  The circle radius.
Returns number
- Defined in circle2d.ts:23

`Static` getPerimeter

getPerimeter(radius): number
Gets the perimeter of a circle.
Parameters
- radius: number
  The circle radius.
Returns number
- Defined in circle2d.ts:15

Generated using TypeDoc