melonJS
    Preparing search index...

    Class Ellipse

    an ellipse Object

    Index
    constructor
    collisionMask? collisionType? isActive? isTrigger? pos radius radiusV ratio type
    angle
    clone contains getBounds rotate scale scaleV setShape toPolygon transform translate updateBounds

    • 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

    collisionMask?: number
    collisionType?: number

    Optional per-shape collision settings, honoured by Body#addShape and defaulted there. Declared rather than initialized: the body writes them when the shape joins it, so a class field here would emit an undefined own property on every shape ever built. See addShape for the table of defaults and what each one does.

    Body#addShape

    isActive?: boolean

    false takes this shape out of collision without removing it

    isTrigger?: boolean

    true reports contacts but skips the position correction

    pos: Vector2d

    the center coordinates of the ellipse

    radius: number

    Maximum radius of the ellipse

    radiusV: Vector2d

    Pre-scaled radius vector for ellipse

    ratio: Vector2d

    x/y scaling ratio for ellipse

    type: string = "Ellipse"

    the shape type (used internally)

    • 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

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

    • check if this circle/ellipse contains the specified point

      Parameters

      • vector: XYPoint

      Returns boolean

      true if contains

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

    • Scale this Ellipse by the specified scalar. The rotation is kept, and the factors apply along the ellipse's own axes: on a rotated ellipse x scales the radius that was radiusV.x before the rotation, wherever it now points.

      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

    • 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 object chaining

    • 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

    • 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

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

    • translate the circle/ellipse by the specified offset

      Parameters

      • vector: XYPoint

      Returns Ellipse

      this ellipse

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

    • update the bounding box for this ellipse, taking rotation into account. Call it after changing pos directly; setShape, translate, scale and rotate already do.

      Returns Bounds

      this shape bounding box Rectangle object

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods