math.geom2d.conic
Class CircleArc2D

java.lang.Object
  extended by math.geom2d.conic.EllipseArc2D
      extended by math.geom2d.conic.CircleArc2D
All Implemented Interfaces:
java.awt.Shape, ContinuousCurve2D, ContinuousOrientedCurve2D, Curve2D, OrientedCurve2D, SmoothCurve2D, SmoothOrientedCurve2D, Shape2D

public class CircleArc2D
extends EllipseArc2D

A circle arc, defined by the center and the radius of the containing circle, by a starting angle, and by a (signed) angle extent.

A circle arc is directed: if angle extent is positive, the arc is counter clockwise. Otherwise, it is clockwise.

A circle arc is parameterized using angle from center. The arc contains all points with a parametric equation of t, for each t between 0 and the angle extent.

Author:
dlegland

Field Summary
protected  Circle2D circle
           
 
Fields inherited from class math.geom2d.conic.EllipseArc2D
angleExtent, ellipse, startAngle
 
Fields inherited from interface math.geom2d.curve.ContinuousCurve2D
CIRCLE, CLOSED_EDGE, LOOP, OPEN_EDGE
 
Fields inherited from interface math.geom2d.Shape2D
ACCURACY, defaultClipWindow, EMPTY_SET
 
Constructor Summary
CircleArc2D()
          Create a circle arc whose support circle is centered on (0,0) and has a radius equal to 1.
CircleArc2D(Circle2D circle, double startAngle, double angleExtent)
          create a new circle arc based on an already existing circle.
CircleArc2D(Circle2D circle, double startAngle, double endAngle, boolean direct)
          create a new circle arc based on an already existing circle, specifying if arc is direct or not.
CircleArc2D(Circle2D circle, Point2D startPoint, Point2D endPoint)
          create a new circle arc based on an already existing circle, and two points giving angles of arc, assuming arc is direct.
CircleArc2D(Circle2D circle, Point2D startPoint, Point2D endPoint, boolean direct)
          Deprecated. as this is a too much specific function.
CircleArc2D(double xc, double yc, double r, double start, double extent)
          Base constructor with all parameters specified
CircleArc2D(double xc, double yc, double r, double start, double end, boolean direct)
          Base constructor, for constructiong arc from circle parameters, start and end angles, and by specifying whether arc is direct or not.
CircleArc2D(Point2D center, double radius, double startAngle, double angleExtent)
          Create a new circle arc with specified point center and radius
CircleArc2D(Point2D center, double radius, double start, double end, boolean direct)
          Create a new circle arc with specified point center and radius, start and end angles, and by specifying whether arc is direct or not.
 
Method Summary
 java.awt.geom.GeneralPath appendPath(java.awt.geom.GeneralPath path)
          Append the path of the curve to the given path.
 CurveSet2D<CircleArc2D> clip(Box2D box)
          Clip the circle arc by a box.
 boolean contains(double x, double y)
           
 boolean contains(double arg0, double arg1, double arg2, double arg3)
          Always return false
 boolean contains(java.awt.geom.Point2D p)
           
 boolean contains(java.awt.geom.Rectangle2D arg0)
          Always return false
 boolean containsAngle(double angle)
           
 boolean equals(java.lang.Object obj)
          two circle arc arre equal if the have same center, same radius, same starting and ending angles, and same orientation.
 Point2D getCenter()
          Deprecated. should access center from supporting circle
 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. fillable) shape.
 double getDistance(java.awt.geom.Point2D p)
          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.
 Point2D getFirstPoint()
          Get the first point of the curve.
protected  java.awt.geom.GeneralPath getGeneralPath()
          Get the path, with moveTo().
 java.util.Collection<Point2D> getIntersections(StraightObject2D line)
          Compute intersections of the circle arc with a line.
 Point2D getLastPoint()
          Get the last point of the curve.
 double getLength()
           
 java.awt.geom.PathIterator getPathIterator(java.awt.geom.AffineTransform trans)
          Return pathiterator for this circle arc.
 java.awt.geom.PathIterator getPathIterator(java.awt.geom.AffineTransform trans, double flatness)
          Return pathiterator for this circle arc.
 Point2D getPoint(double t)
          Returns the position of a point form the curvilinear position.
 Point2D getPoint(double t, Point2D point)
          Same as getPoint(t), but gives the point as a parameter.
 double getPosition(Point2D point)
          return relative position between 0 and the angle extent.
 double getRadius()
          Deprecated. should access radius from supporting circle
 CircleArc2D getReverseCurve()
          returns the circle arc which refers to the reversed parent circle, with same start angle, and with opposite angle extent.
 double getSignedDistance(double x, double y)
          The same as getSignedDistance(Point2D), but by passing 2 double as arguments.
 double getSignedDistance(java.awt.geom.Point2D p)
          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.
 java.util.Collection<? extends SmoothCurve2D> getSmoothPieces()
          return a SmoothCurve array containing this ellipse arc.
 CircleArc2D getSubCurve(double t0, double t1)
          return a new CircleArc2D.
 Circle2D getSupportCircle()
          Returns the circle which contains the circle arc.
 double getT0()
          Always return 0
 double getT1()
          return the last position of the circle are, which is given by the angle extent of the arc.
 Vector2D getTangent(double t)
           
 double getWindingAngle(java.awt.geom.Point2D point)
          Return the angle portion that the curve turn around the given point.
 boolean intersects(double x, double y, double w, double h)
           
 boolean intersects(java.awt.geom.Rectangle2D r)
           
 boolean isBounded()
          Always return true
 boolean isClosed()
          a circle arc is never closed by definition.
 boolean isDirect()
           
 boolean isInside(java.awt.geom.Point2D point)
          return true if the point is 'inside' the domain bounded by the curve.
 void setArc(Point2D center, double radius, double start, double extent)
           
 void setArc(Point2D center, double radius, double start, double end, boolean direct)
          Deprecated. 
 void setCenter(Point2D point)
          Change the center of the support circle.
 void setRadius(double r)
          Change the radius of the support circle
 EllipseArc2D transform(AffineTransform2D trans)
          return an instance of EllipseArc2D, or CircleArc2D if transform is a similarity.
 
Methods inherited from class math.geom2d.conic.EllipseArc2D
getAngle, getAsPolyline, getBoundingBox, getBounds, getBounds2D, getContinuousCurves, getCurvature, getInnerPath, project
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

circle

protected Circle2D circle
Constructor Detail

CircleArc2D

public CircleArc2D()
Create a circle arc whose support circle is centered on (0,0) and has a radius equal to 1. Start angle is 0, and angle extent is PI/2.


CircleArc2D

public CircleArc2D(Circle2D circle,
                   double startAngle,
                   double angleExtent)
create a new circle arc based on an already existing circle.


CircleArc2D

public CircleArc2D(Circle2D circle,
                   double startAngle,
                   double endAngle,
                   boolean direct)
create a new circle arc based on an already existing circle, specifying if arc is direct or not.


CircleArc2D

public CircleArc2D(Circle2D circle,
                   Point2D startPoint,
                   Point2D endPoint,
                   boolean direct)
Deprecated. as this is a too much specific function.

create a new circle arc based on an already existing circle, and two points giving angles of arc, specifying whether arc is direct or not.


CircleArc2D

public CircleArc2D(Circle2D circle,
                   Point2D startPoint,
                   Point2D endPoint)
create a new circle arc based on an already existing circle, and two points giving angles of arc, assuming arc is direct.


CircleArc2D

public CircleArc2D(Point2D center,
                   double radius,
                   double startAngle,
                   double angleExtent)
Create a new circle arc with specified point center and radius


CircleArc2D

public CircleArc2D(Point2D center,
                   double radius,
                   double start,
                   double end,
                   boolean direct)
Create a new circle arc with specified point center and radius, start and end angles, and by specifying whether arc is direct or not.


CircleArc2D

public CircleArc2D(double xc,
                   double yc,
                   double r,
                   double start,
                   double end,
                   boolean direct)
Base constructor, for constructiong arc from circle parameters, start and end angles, and by specifying whether arc is direct or not.


CircleArc2D

public CircleArc2D(double xc,
                   double yc,
                   double r,
                   double start,
                   double extent)
Base constructor with all parameters specified

Method Detail

containsAngle

public boolean containsAngle(double angle)

getRadius

public double getRadius()
Deprecated. should access radius from supporting circle


getCenter

public Point2D getCenter()
Deprecated. should access center from supporting circle


getSupportCircle

public Circle2D getSupportCircle()
Returns the circle which contains the circle arc.


setCenter

public void setCenter(Point2D point)
Change the center of the support circle.

Parameters:
point - the new center of the arc.

setRadius

public void setRadius(double r)
Change the radius of the support circle

Parameters:
r - the new radius

setArc

public void setArc(Point2D center,
                   double radius,
                   double start,
                   double extent)

setArc

@Deprecated
public void setArc(Point2D center,
                              double radius,
                              double start,
                              double end,
                              boolean direct)
Deprecated. 


isDirect

public boolean isDirect()

getLength

public double getLength()

getWindingAngle

public double getWindingAngle(java.awt.geom.Point2D point)
Description copied from interface: OrientedCurve2D
Return the angle portion that the curve turn around the given point. Result is a signed angle.

Specified by:
getWindingAngle in interface OrientedCurve2D
Overrides:
getWindingAngle in class EllipseArc2D
Parameters:
point - a point of the plane
Returns:
a signed angle

isInside

public boolean isInside(java.awt.geom.Point2D point)
Description copied from interface: OrientedCurve2D
return true if the point is 'inside' the domain bounded by the curve.

Specified by:
isInside in interface OrientedCurve2D
Overrides:
isInside in class EllipseArc2D
Parameters:
point - a point in the plane
Returns:
true if the point is on the left side of the curve.

getSignedDistance

public double getSignedDistance(java.awt.geom.Point2D p)
Description copied from interface: OrientedCurve2D
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. In this case, absolute value of distance is equals to the distance to the border of the shape.

Specified by:
getSignedDistance in interface OrientedCurve2D
Overrides:
getSignedDistance in class EllipseArc2D
Parameters:
p - a point of the plane
Returns:
the signed distance to the curve

getSignedDistance

public double getSignedDistance(double x,
                                double y)
Description copied from interface: OrientedCurve2D
The same as getSignedDistance(Point2D), but by passing 2 double as arguments.

Specified by:
getSignedDistance in interface OrientedCurve2D
Overrides:
getSignedDistance in class EllipseArc2D
Parameters:
x - x-coord of a point
y - y-coord of a point
Returns:
the signed distance of the point (x,y) to the curve

getTangent

public Vector2D getTangent(double t)
Specified by:
getTangent in interface SmoothCurve2D
Overrides:
getTangent in class EllipseArc2D

getSmoothPieces

public java.util.Collection<? extends SmoothCurve2D> getSmoothPieces()
Description copied from class: EllipseArc2D
return a SmoothCurve array containing this ellipse arc.

Specified by:
getSmoothPieces in interface ContinuousCurve2D
Overrides:
getSmoothPieces in class EllipseArc2D
See Also:
math.geom2d.ContinuousCurve2D#getSmoothPieces()

isClosed

public boolean isClosed()
a circle arc is never closed by definition.

Specified by:
isClosed in interface ContinuousCurve2D
Overrides:
isClosed in class EllipseArc2D

getT0

public double getT0()
Always return 0

Specified by:
getT0 in interface Curve2D
Overrides:
getT0 in class EllipseArc2D

getT1

public double getT1()
return the last position of the circle are, which is given by the angle extent of the arc.

Specified by:
getT1 in interface Curve2D
Overrides:
getT1 in class EllipseArc2D

getPoint

public Point2D getPoint(double t)
Returns the position of a point form the curvilinear position.

Specified by:
getPoint in interface Curve2D
Overrides:
getPoint in class EllipseArc2D

getPoint

public Point2D getPoint(double t,
                        Point2D point)
Description copied from interface: Curve2D
Same as getPoint(t), but gives the point as a parameter. This avoids repetitive memory allocations.

Specified by:
getPoint in interface Curve2D
Overrides:
getPoint in class EllipseArc2D

getFirstPoint

public Point2D getFirstPoint()
Get the first point of the curve.

Specified by:
getFirstPoint in interface Curve2D
Overrides:
getFirstPoint in class EllipseArc2D
Returns:
the first point of the curve

getLastPoint

public Point2D getLastPoint()
Get the last point of the curve.

Specified by:
getLastPoint in interface Curve2D
Overrides:
getLastPoint in class EllipseArc2D
Returns:
the last point of the curve.

getPosition

public double getPosition(Point2D point)
return relative position between 0 and the angle extent.

Specified by:
getPosition in interface Curve2D
Overrides:
getPosition in class EllipseArc2D
Parameters:
point - a point belonging to the curve
Returns:
the position of the point on the curve

getIntersections

public java.util.Collection<Point2D> getIntersections(StraightObject2D line)
Compute intersections of the circle arc with a line. Return an array of Point2D, of size 0, 1 or 2 depending on the distance between circle and line. If there are 2 intersections points, the first one in the array is the first one on the line.

Specified by:
getIntersections in interface Curve2D
Overrides:
getIntersections in class EllipseArc2D

getDistance

public double getDistance(java.awt.geom.Point2D p)
Description copied from interface: Shape2D
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.

Specified by:
getDistance in interface Shape2D
Overrides:
getDistance in class EllipseArc2D

getDistance

public double getDistance(double x,
                          double y)
Description copied from interface: Shape2D
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. fillable) shape.

Specified by:
getDistance in interface Shape2D
Overrides:
getDistance in class EllipseArc2D

isBounded

public boolean isBounded()
Always return true

Specified by:
isBounded in interface Shape2D
Overrides:
isBounded in class EllipseArc2D

getSubCurve

public CircleArc2D getSubCurve(double t0,
                               double t1)
return a new CircleArc2D. Variables t0 and t1 must be comprised between 0 and the angle extent of the arc.

Specified by:
getSubCurve in interface ContinuousCurve2D
Specified by:
getSubCurve in interface ContinuousOrientedCurve2D
Specified by:
getSubCurve in interface Curve2D
Specified by:
getSubCurve in interface SmoothCurve2D
Specified by:
getSubCurve in interface SmoothOrientedCurve2D
Overrides:
getSubCurve in class EllipseArc2D
Parameters:
t0 - position of the start of the sub-curve
t1 - position of the end of the sub-curve
Returns:
the portion of original curve comprised between t0 and t1.

getReverseCurve

public CircleArc2D getReverseCurve()
returns the circle arc which refers to the reversed parent circle, with same start angle, and with opposite angle extent.

Specified by:
getReverseCurve in interface ContinuousCurve2D
Specified by:
getReverseCurve in interface ContinuousOrientedCurve2D
Specified by:
getReverseCurve in interface Curve2D
Specified by:
getReverseCurve in interface OrientedCurve2D
Specified by:
getReverseCurve in interface SmoothCurve2D
Specified by:
getReverseCurve in interface SmoothOrientedCurve2D
Overrides:
getReverseCurve in class EllipseArc2D

clip

public CurveSet2D<CircleArc2D> clip(Box2D box)
Clip the circle arc by a box. The result is a CurveSet2D, which contains only instances of CircleArc2D. If circle arc is not clipped, the result is an instance of CurveSet2D with zero curves.

Specified by:
clip in interface ContinuousCurve2D
Specified by:
clip in interface ContinuousOrientedCurve2D
Specified by:
clip in interface Curve2D
Specified by:
clip in interface OrientedCurve2D
Specified by:
clip in interface SmoothCurve2D
Specified by:
clip in interface SmoothOrientedCurve2D
Specified by:
clip in interface Shape2D
Overrides:
clip in class EllipseArc2D
Parameters:
box - the clipping box
Returns:
the clipped shape

transform

public EllipseArc2D transform(AffineTransform2D trans)
return an instance of EllipseArc2D, or CircleArc2D if transform is a similarity.

Specified by:
transform in interface ContinuousCurve2D
Specified by:
transform in interface ContinuousOrientedCurve2D
Specified by:
transform in interface Curve2D
Specified by:
transform in interface OrientedCurve2D
Specified by:
transform in interface SmoothCurve2D
Specified by:
transform in interface SmoothOrientedCurve2D
Specified by:
transform in interface Shape2D
Overrides:
transform in class EllipseArc2D
Parameters:
trans - an affine transform
Returns:
the transformed shape

contains

public boolean contains(java.awt.geom.Point2D p)
Specified by:
contains in interface java.awt.Shape
Overrides:
contains in class EllipseArc2D

contains

public boolean contains(double x,
                        double y)
Specified by:
contains in interface java.awt.Shape
Overrides:
contains in class EllipseArc2D

intersects

public boolean intersects(double x,
                          double y,
                          double w,
                          double h)
Specified by:
intersects in interface java.awt.Shape
Overrides:
intersects in class EllipseArc2D

intersects

public boolean intersects(java.awt.geom.Rectangle2D r)
Specified by:
intersects in interface java.awt.Shape
Overrides:
intersects in class EllipseArc2D

contains

public boolean contains(double arg0,
                        double arg1,
                        double arg2,
                        double arg3)
Always return false

Specified by:
contains in interface java.awt.Shape
Overrides:
contains in class EllipseArc2D

contains

public boolean contains(java.awt.geom.Rectangle2D arg0)
Always return false

Specified by:
contains in interface java.awt.Shape
Overrides:
contains in class EllipseArc2D

appendPath

public java.awt.geom.GeneralPath appendPath(java.awt.geom.GeneralPath path)
Description copied from interface: ContinuousCurve2D
Append the path of the curve to the given path.

Specified by:
appendPath in interface ContinuousCurve2D
Overrides:
appendPath in class EllipseArc2D
Parameters:
path - a path to modify
Returns:
the modified path

getGeneralPath

protected java.awt.geom.GeneralPath getGeneralPath()
Get the path, with moveTo().

Overrides:
getGeneralPath in class EllipseArc2D
Returns:
the general path for this circle

getPathIterator

public java.awt.geom.PathIterator getPathIterator(java.awt.geom.AffineTransform trans)
Return pathiterator for this circle arc.

Specified by:
getPathIterator in interface java.awt.Shape
Overrides:
getPathIterator in class EllipseArc2D

getPathIterator

public java.awt.geom.PathIterator getPathIterator(java.awt.geom.AffineTransform trans,
                                                  double flatness)
Return pathiterator for this circle arc.

Specified by:
getPathIterator in interface java.awt.Shape
Overrides:
getPathIterator in class EllipseArc2D

equals

public boolean equals(java.lang.Object obj)
two circle arc arre equal if the have same center, same radius, same starting and ending angles, and same orientation.

Overrides:
equals in class EllipseArc2D