Ellipse2D (java-geom 3.3.1-SNAPSHOT API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

math.geom2d.conic
Class Ellipse2D

java.lang.Object
  math.geom2d.curve.AbstractContinuousCurve2D
      math.geom2d.curve.AbstractSmoothCurve2D
          math.geom2d.conic.Ellipse2D

All Implemented Interfaces:: Serializable, Cloneable, Conic2D, ContinuousCurve2D, Curve2D, SmoothCurve2D, Boundary2D, ContinuousBoundary2D, ContinuousOrientedCurve2D, OrientedCurve2D, SmoothBoundary2D, SmoothOrientedCurve2D, Shape2D

Direct Known Subclasses:: Circle2D

public class Ellipse2D
extends AbstractSmoothCurve2D
implements SmoothBoundary2D, Conic2D, Cloneable
extends AbstractSmoothCurve2D
implements SmoothBoundary2D, Conic2D, Cloneable

An ellipse in the plane. It is defined by the center, the orientation angle, and the lengths of the two axis. No convention is taken about lengths of semiaxis : the second semi axis can be greater than the first one.

See Also:: Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface math.geom2d.conic.Conic2D
`Conic2D.Type`

Field Summary
`protected boolean`	`direct` directed ellipse or not
`protected double`	`r1` length of major semi-axis
`protected double`	`r2` length of minor semi-axis
`protected double`	`theta` orientation of major semi-axis
`protected double`	`xc` coordinate of center.
`protected double`	`yc`

Fields inherited from interface math.geom2d.Shape2D
`ACCURACY`

Constructor Summary
`Ellipse2D()` Empty constructor, define ellipse centered at origin with both major and minor semi-axis with length equal to 1.
`Ellipse2D(double xc, double yc, double l1, double l2)` Define center by coordinate, plus major and minor semi axis
`Ellipse2D(double xc, double yc, double l1, double l2, double theta)` Define center by coordinate, major and minor semi axis lengths, and orientation angle.
`Ellipse2D(double xc, double yc, double l1, double l2, double theta, boolean direct)` Define center by coordinate, major and minor semi axis lengths, orientation angle, and boolean flag for directed ellipse.
`Ellipse2D(Ellipse2D ellipse)` construct an ellipse from the java.awt.geom class for ellipse.
`Ellipse2D(Point2D center, double l1, double l2)` Main constructor: define center by a point plus major and minor semi axis
`Ellipse2D(Point2D center, double l1, double l2, double theta)` Define center by point, major and minor semi axis lengths, and orientation angle.

Method Summary
`GeneralPath`	`appendPath(GeneralPath path)` Add the path of the ellipse to the given path.
`CurveSet2D<? extends SmoothOrientedCurve2D>`	`clip(Box2D box)` Clip the ellipse by a box.
`Ellipse2D`	`clone()` Overrides Object declaration to ensure Curve2D implementation are cloned as Curve2D.
`boolean`	`contains(double x, double y)` Return true if the point (x, y) lies on the ellipse, with precision given by Shape2D.ACCURACY.
`boolean`	`contains(Point2D p)` Return true if the point p lies on the ellipse, with precision given by Shape2D.ACCURACY.
`static Ellipse2D`	`create(Ellipse2D ellipse)` Constructs an ellipse from the java.awt.geom class for ellipse.
`static Ellipse2D`	`create(Point2D center, double l1, double l2)` Main constructor: define center by a point plus major and minor semi axis
`static Ellipse2D`	`create(Point2D center, double l1, double l2, double theta)` Define center by point, major and minor semi axis lengths, and orientation angle.
`static Ellipse2D`	`create(Point2D center, double l1, double l2, double theta, boolean direct)` Define center by point, major and minor semi axis lengths, orientation angle, and boolean flag for direct ellipse.
`static Ellipse2D`	`create(Point2D focus1, Point2D focus2, double chord)` Create a new Ellipse by specifying the two focii, and the length of the chord.
`void`	`draw(Graphics2D g2)` Draws the curve on the given Graphics2D object.
`boolean`	`equals(Object obj)`
`void`	`fill(Graphics2D g2)`
`double`	`getAngle()` return the angle of the ellipse first axis with the Ox axis.
`Collection<? extends Ellipse2D>`	`getBoundaryCurves()` Returns the different continuous curves composing the boundary
`Box2D`	`getBoundingBox()` Return more precise bounds for the ellipse.
`Point2D`	`getCenter()` Returns center of the ellipse.
`double[]`	`getConicCoefficients()` Returns the conic coefficients of the ellipse.
`Conic2D.Type`	`getConicType()`
`Collection<? extends Ellipse2D>`	`getContinuousCurves()` Returns the collection of continuous curves which constitute this curve.
`double`	`getCurvature(double t)` Returns the curvature of the ellipse.
`double`	`getDistance(double x, double y)` get the distance of the shape to the given point, specified by x and y, or the distance of point to the frontier of the shape in the case of a plain (i.e.
`double`	`getDistance(Point2D point)` get the distance of the shape to the given point, or the distance of point to the frontier of the shape in the case of a plain shape.
`Domain2D`	`getDomain()` Returns the domain delimited by this boundary.
`double`	`getEccentricity()` Computes eccentricity of ellipse, depending on the lengths of the semi-axes.
`Point2D`	`getFirstPoint()` Get the first point of the ellipse, which is the same as the last point.
`Point2D`	`getFocus1()` Return the first focus.
`Point2D`	`getFocus2()` Returns the second focus.
`GeneralPath`	`getGeneralPath()`
`Collection<Point2D>`	`getIntersections(LinearShape2D line)` Compute intersections of the ellipse with a straight object (line, line segment, ray...).
`Point2D`	`getLastPoint()` Get the last point of the ellipse, which is the same as the first point.
`Ellipse2D`	`getParallel(double d)` Return the parallel ellipse located at a distance d from this ellipse.
`Point2D`	`getPoint(double t)` get the position of the curve from internal parametric representation, depending on the parameter t.
`double`	`getPosition(Point2D point)` Get position of the point on the curve.
`Point2D`	`getProjectedPoint(Point2D point)`
`Vector2D`	`getProjectedVector(Point2D point, double eMax)` Compute projection of a point onto an ellipse.
`Ellipse2D`	`getReverseCurve()` Returns the ellipse with same center and same radius, but with the other orientation.
`double`	`getRho(double angle)` Return the RHO parameter, in a polar representation of the ellipse, centered at the center of ellipse.
`double`	`getSemiMajorAxisLength()` Returns the length of the major semi-axis of the ellipse.
`double`	`getSemiMinorAxisLength()` Returns the length of the minor semi-axis of the ellipse.
`double`	`getSignedDistance(double x, double y)` The same as getSignedDistance(Point2D), but by passing 2 double as arguments.
`double`	`getSignedDistance(Point2D point)` Get the signed distance of the curve to the given point: this distance is positive if the point lies outside the shape, and is negative if the point lies inside the shape.
`EllipseArc2D`	`getSubCurve(double t0, double t1)` return a new EllipseArc2D.
`double`	`getT0()` Returns the parameter of the first point of the ellipse, set to 0.
`double`	`getT1()` Returns the parameter of the last point of the ellipse, set to 2*PI.
`Vector2D`	`getTangent(double t)`
`Vector2D`	`getVector1()`
`Vector2D`	`getVector2()`
`double`	`getWindingAngle(Point2D point)` Return either 0, 2PI or -2PI, depending whether the point is located inside the interior of the ellipse or not.
`boolean`	`isBounded()` Always returns true, because an ellipse is bounded.
`boolean`	`isCircle()`
`boolean`	`isClosed()` Returns true, as an ellipse is always closed.
`boolean`	`isDirect()` return true if ellipse has a direct orientation.
`boolean`	`isEmpty()` Returns true if the shape does not contain any point.
`boolean`	`isInside(Point2D point)` Test whether the point is inside the ellipse.
`double`	`project(Point2D point)` Computes the approximate projection position of the point on the ellipse.
`static Ellipse2D`	`reduceCentered(double[] coefs)` Creates a new Ellipse by reducing the conic coefficients, assuming conic type is ellipse, and ellipse is centered.
`void`	`setCenter(double x, double y)` Deprecated. conics will become immutable in a future release
`void`	`setCenter(Point2D center)` Deprecated. conics will become immutable in a future release
`void`	`setEllipse(double xc, double yc, double r1, double r2, double theta)` Deprecated. conics will become immutable in a future release
`void`	`setEllipse(double xc, double yc, double r1, double r2, double theta, boolean direct)` Deprecated. conics will become immutable in a future release
`void`	`setEllipse(Point2D center, double r1, double r2, double theta)` Deprecated. conics will become immutable in a future release
`void`	`setEllipse(Point2D center, double r1, double r2, double theta, boolean direct)` Deprecated. conics will become immutable in a future release
`String`	`toString()`
`Ellipse2D`	`transform(AffineTransform2D trans)` Transforms this ellipse by an affine transform.
`static Ellipse2D`	`transformCentered(Ellipse2D ellipse, AffineTransform2D trans)` Transform an ellipse, by supposing both the ellipse is centered and the transform has no translation part.

Methods inherited from class math.geom2d.curve.AbstractSmoothCurve2D
`getLeftTangent, getRightTangent, getSingularPoints, getSmoothPieces, isSingular`

Methods inherited from class math.geom2d.curve.AbstractContinuousCurve2D
`getAsAWTShape, getAsPolyline, wrapCurve`

Methods inherited from class java.lang.Object
`finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Methods inherited from interface math.geom2d.curve.ContinuousCurve2D
`getAsPolyline, getLeftTangent, getRightTangent, getSmoothPieces`

Methods inherited from interface math.geom2d.curve.Curve2D
`getAsAWTShape, getSingularPoints, isSingular`

Field Detail

xc

protected double xc

coordinate of center.

yc

protected double yc

r1

protected double r1

length of major semi-axis

r2

protected double r2

length of minor semi-axis

theta

protected double theta

orientation of major semi-axis

direct

protected boolean direct

directed ellipse or not

Constructor Detail

Ellipse2D

public Ellipse2D()

Empty constructor, define ellipse centered at origin with both major and minor semi-axis with length equal to 1.

Ellipse2D

public Ellipse2D(Point2D center,
                 double l1,
                 double l2)

Main constructor: define center by a point plus major and minor semi axis

Ellipse2D

public Ellipse2D(double xc,
                 double yc,
                 double l1,
                 double l2)

Define center by coordinate, plus major and minor semi axis

Ellipse2D

public Ellipse2D(Point2D center,
                 double l1,
                 double l2,
                 double theta)

Define center by point, major and minor semi axis lengths, and orientation angle.

Ellipse2D

public Ellipse2D(double xc,
                 double yc,
                 double l1,
                 double l2,
                 double theta)

Define center by coordinate, major and minor semi axis lengths, and orientation angle.

Ellipse2D

public Ellipse2D(double xc,
                 double yc,
                 double l1,
                 double l2,
                 double theta,
                 boolean direct)

Define center by coordinate, major and minor semi axis lengths, orientation angle, and boolean flag for directed ellipse.

Ellipse2D

public Ellipse2D(Ellipse2D ellipse)

construct an ellipse from the java.awt.geom class for ellipse.

Method Detail

create

public static Ellipse2D create(Point2D focus1,
                               Point2D focus2,
                               double chord)

Create a new Ellipse by specifying the two focii, and the length of the chord. The chord equals the sum of distances between a point of the ellipse and each focus.

Parameters:: focus1 - the first focus; focus2 - the second focus; chord - the sum of distances to focii
Returns:: a new instance of Ellipse2D

create

public static Ellipse2D create(Point2D center,
                               double l1,
                               double l2)

Main constructor: define center by a point plus major and minor semi axis

create

public static Ellipse2D create(Point2D center,
                               double l1,
                               double l2,
                               double theta)

Define center by point, major and minor semi axis lengths, and orientation angle.

create

public static Ellipse2D create(Point2D center,
                               double l1,
                               double l2,
                               double theta,
                               boolean direct)

Define center by point, major and minor semi axis lengths, orientation angle, and boolean flag for direct ellipse.

create

public static Ellipse2D create(Ellipse2D ellipse)

Constructs an ellipse from the java.awt.geom class for ellipse.

reduceCentered

public static final Ellipse2D reduceCentered(double[] coefs)

Creates a new Ellipse by reducing the conic coefficients, assuming conic type is ellipse, and ellipse is centered.

Parameters:: coefs - an array of double with at least 3 coefficients containing coefficients for x^2, xy, and y^2 factors.
Returns:: the Ellipse2D corresponding to given coefficients

transformCentered

public static final Ellipse2D transformCentered(Ellipse2D ellipse,
                                                AffineTransform2D trans)

Transform an ellipse, by supposing both the ellipse is centered and the transform has no translation part.

Parameters:: ellipse - an ellipse; trans - an affine transform
Returns:: the transformed ellipse, centered around origin