Class Ellipse

constructor

• new Ellipse(x: number, y: number, w: number, h: number): Ellipse

  Parameters

  • x: number

    the center x coordinate of the ellipse

  • y: number

    the center y coordinate of the ellipse

  • w: number

    width (diameter) of the ellipse

  • h: number

    height (diameter) of the ellipse

  Returns Ellipse

_bounds

pos

radius

radiusV

ratio

type

angle

• get angle(): number

  the rotation angle of the ellipse in radians

  Returns number

• set angle(value: number): void

  Parameters

  • value: number

  Returns void

clone

• clone(): Ellipse

  clone this Ellipse

  Returns Ellipse

  new Ellipse

contains

• contains(x: number, y?: number): boolean

  check if this circle/ellipse contains the specified point

  Parameters

  • x: number

    x coordinate or a vector point to check

  • Optionaly: number

    y coordinate

  Returns boolean

  true if contains

  Example

  if (circle.contains(10, 10)) {
    // do something
  }
  // or
  if (circle.contains(myVector2d)) {
   // do something
  }
  Copy

• contains(vector: Vector2d): boolean

  check if this circle/ellipse contains the specified point

  Parameters

  • vector: Vector2d

  Returns boolean

  true if contains

  Example

  if (circle.contains(10, 10)) {
    // do something
  }
  // or
  if (circle.contains(myVector2d)) {
   // do something
  }
  Copy

getBounds

• getBounds(): Bounds

  returns the bounding box for this shape, the smallest Rectangle object completely containing this shape.

  Returns Bounds

  this shape bounding box Rectangle object

rotate

• rotate(angle: number, v?: Vector2d): Ellipse

  Rotate this Ellipse (counter-clockwise) by the specified angle (in radians).

  Parameters

  • angle: number

    The angle to rotate (in radians)

  • Optionalv: Vector2d

    an optional point to rotate around

  Returns Ellipse

  Reference to this object for method chaining

scale

• scale(x: number, y?: number): Ellipse

  Scale this Ellipse by the specified scalar.

  Parameters

  • x: number

    the scale factor along the x-axis

  • Optionaly: number = x

    the scale factor along the y-axis

  Returns Ellipse

  Reference to this object for method chaining

scaleV

• scaleV(v: Vector2d): Ellipse

  Scale this Ellipse by the specified vector.

  Parameters

  • v: Vector2d

    Scaling vector.

  Returns Ellipse

  Reference to this object for method chaining

setShape

• setShape(x: number, y: number, w: number, h: number): Ellipse

  set new value to the Ellipse shape

  Parameters

  • x: number

    the center x coordinate of the ellipse

  • y: number

    the center y coordinate of the ellipse

  • w: number

    width (diameter) of the ellipse

  • h: number

    height (diameter) of the ellipse

  Returns Ellipse

  this instance for objecf chaining

toPolygon

• toPolygon(segments?: number): Polygon

  Returns a polygon approximation of this ellipse. The polygon is cached and only recomputed when the ellipse shape changes.

  Parameters

  • Optionalsegments: number = 16

    the number of segments to use for the approximation

  Returns Polygon

  a Polygon representing this ellipse

transform

• transform(m: Matrix2d): Ellipse

  apply the given transformation matrix to this ellipse

  Parameters

  • m: Matrix2d

    the transformation matrix

  Returns Ellipse

  Reference to this object for method chaining

translate

• translate(x: number, y?: number): Ellipse

  translate the circle/ellipse by the specified offset

  Parameters

  • x: number

    x coordinate or a vector point to translate by

  • Optionaly: number

    y offset

  Returns Ellipse

  this ellipse

  Example

  ellipse.translate(10, 10);
  // or
  ellipse.translate(myVector2d);
  Copy

• translate(vector: Vector2d): Ellipse

  translate the circle/ellipse by the specified offset

  Parameters

  • vector: Vector2d

  Returns Ellipse

  this ellipse

  Example

  ellipse.translate(10, 10);
  // or
  ellipse.translate(myVector2d);
  Copy