Class Ellipse2d

Defines an ellipse in two-dimensional coordinates.

See

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

Hierarchy

Ellipse2d

Implements

IClosedShape2d

Index

Constructors

Properties

_center height width

Accessors

area center eccentricity f1 f2 perimeter

Methods

computeCheckpoint contains doesIntersect getIntersectionPoints isOnEdge rotate translate getArea getPerimeter

Constructors

constructor

new Ellipse2d(center, width, height): Ellipse2d
Parameters
- center: Point2d
- width: number
- height: number
Returns Ellipse2d
- Defined in ellipse2d.ts:48

Properties

`Private` _center

_center: Point2d

height

height: number

Gets or sets the height of the ellipse.

width

width: number

Gets or sets the width of the ellipse.

Accessors

area

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

Returns number
Implementation of IClosedShape2d.area
- Defined in ellipse2d.ts:73

center

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

Returns Point2d
- Defined in ellipse2d.ts:57

eccentricity

get eccentricity(): number
Gets the linear eccentricity of the ellipse.

Returns number
- Defined in ellipse2d.ts:82

f1

get f1(): Point2d
Gets the first focus point of the ellipse.

Returns Point2d
- Defined in ellipse2d.ts:93

f2

get f2(): Point2d
Gets the second focus point of the ellipse.

Returns Point2d
- Defined in ellipse2d.ts:102

perimeter

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

Returns number
Implementation of IClosedShape2d.perimeter
- Defined in ellipse2d.ts:64

Methods

`Private` computeCheckpoint

computeCheckpoint(point): number
Parameters
- point: Point2d
Returns number
- Defined in ellipse2d.ts:129

contains

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

doesIntersect

doesIntersect(shape): boolean
Checks if the current ellipse 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 ellipse2d.ts:166

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 ellipse2d.ts:175

isOnEdge

isOnEdge(point, threshold?): boolean
Checks if the given point is on one edge of the ellipse.
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
Implementation of IClosedShape2d.isOnEdge
- Defined in ellipse2d.ts:144

rotate

rotate(angle, origin?): void
Rotates the ellipse 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 ellipse2d.ts:121

translate

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

`Static` getArea

getArea(semiMajorAxis, semiMinorAxis): number
Gets the area of an ellipse.
Parameters
- semiMajorAxis: number
  The ellipse semi-major axis.
- semiMinorAxis: number
  The ellipse semi-minor axis.
Returns number
- Defined in ellipse2d.ts:34

`Static` getPerimeter

getPerimeter(semiMajorAxis, semiMinorAxis): number
Gets the perimeter of an ellipse.
Parameters
- semiMajorAxis: number
  The ellipse semi-major axis.
- semiMinorAxis: number
  The ellipse semi-minor axis.
Returns number
- Defined in ellipse2d.ts:16

Generated using TypeDoc