- java.lang.Object
-
- java.awt.geom.RectangularShape
-
- java.awt.geom.Arc2D
-
- Direct Known Subclasses:
Arc2D.Double,Arc2D.Float
public abstract class Arc2D extends RectangularShape
Arc2Dis the abstract superclass for all objects that store a 2D arc defined by a framing rectangle, start angle, angular extent (length of the arc), and a closure type (OPEN,CHORD, orPIE).The arc is a partial section of a full ellipse which inscribes the framing rectangle of its parent
RectangularShape. The angles are specified relative to the non-square framing rectangle such that 45 degrees always falls on the line from the center of the ellipse to the upper right corner of the framing rectangle. As a result, if the framing rectangle is noticeably longer along one axis than the other, the angles to the start and end of the arc segment will be skewed farther along the longer axis of the frame.The actual storage representation of the coordinates is left to the subclass.
- Since:
- 1.2
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classArc2D.DoubleThis class defines an arc specified indoubleprecision.static classArc2D.FloatThis class defines an arc specified infloatprecision.
-
Field Summary
Fields Modifier and Type Field Description static intCHORDThe closure type for an arc closed by drawing a straight line segment from the start of the arc segment to the end of the arc segment.static intOPENThe closure type for an open arc with no path segments connecting the two ends of the arc segment.static intPIEThe closure type for an arc closed by drawing straight line segments from the start of the arc segment to the center of the full ellipse and from that point to the end of the arc segment.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description booleancontains(double x, double y)Determines whether or not the specified point is inside the boundary of the arc.booleancontains(double x, double y, double w, double h)Determines whether or not the interior of the arc entirely contains the specified rectangle.booleancontains(Rectangle2D r)Determines whether or not the interior of the arc entirely contains the specified rectangle.booleancontainsAngle(double angle)Determines whether or not the specified angle is within the angular extents of the arc.booleanequals(Object obj)Determines whether or not the specifiedObjectis equal to thisArc2D.abstract doublegetAngleExtent()Returns the angular extent of the arc.abstract doublegetAngleStart()Returns the starting angle of the arc.intgetArcType()Rectangle2DgetBounds2D()Returns the high-precision framing rectangle of the arc.Point2DgetEndPoint()Returns the ending point of the arc.PathIteratorgetPathIterator(AffineTransform at)Returns an iteration object that defines the boundary of the arc.Point2DgetStartPoint()Returns the starting point of the arc.inthashCode()Returns the hashcode for thisArc2D.booleanintersects(double x, double y, double w, double h)Determines whether or not the interior of the arc intersects the interior of the specified rectangle.protected abstract Rectangle2DmakeBounds(double x, double y, double w, double h)Constructs aRectangle2Dof the appropriate precision to hold the parameters calculated to be the framing rectangle of this arc.abstract voidsetAngleExtent(double angExt)Sets the angular extent of this arc to the specified double value.voidsetAngles(double x1, double y1, double x2, double y2)Sets the starting angle and angular extent of this arc using two sets of coordinates.voidsetAngles(Point2D p1, Point2D p2)Sets the starting angle and angular extent of this arc using two points.abstract voidsetAngleStart(double angSt)Sets the starting angle of this arc to the specified double value.voidsetAngleStart(Point2D p)Sets the starting angle of this arc to the angle that the specified point defines relative to the center of this arc.abstract voidsetArc(double x, double y, double w, double h, double angSt, double angExt, int closure)Sets the location, size, angular extents, and closure type of this arc to the specified double values.voidsetArc(Arc2D a)Sets this arc to be the same as the specified arc.voidsetArc(Point2D loc, Dimension2D size, double angSt, double angExt, int closure)Sets the location, size, angular extents, and closure type of this arc to the specified values.voidsetArc(Rectangle2D rect, double angSt, double angExt, int closure)Sets the location, size, angular extents, and closure type of this arc to the specified values.voidsetArcByCenter(double x, double y, double radius, double angSt, double angExt, int closure)Sets the position, bounds, angular extents, and closure type of this arc to the specified values.voidsetArcByTangent(Point2D p1, Point2D p2, Point2D p3, double radius)Sets the position, bounds, and angular extents of this arc to the specified value.voidsetArcType(int type)Sets the closure type of this arc to the specified value:OPEN,CHORD, orPIE.voidsetFrame(double x, double y, double w, double h)Sets the location and size of the framing rectangle of thisShapeto the specified rectangular values.-
Methods declared in class java.awt.geom.RectangularShape
clone, contains, getBounds, getCenterX, getCenterY, getFrame, getHeight, getMaxX, getMaxY, getMinX, getMinY, getPathIterator, getWidth, getX, getY, intersects, isEmpty, setFrame, setFrame, setFrameFromCenter, setFrameFromCenter, setFrameFromDiagonal, setFrameFromDiagonal
-
-
-
-
Field Detail
-
OPEN
public static final int OPEN
The closure type for an open arc with no path segments connecting the two ends of the arc segment.- Since:
- 1.2
- See Also:
- Constant Field Values
-
CHORD
public static final int CHORD
The closure type for an arc closed by drawing a straight line segment from the start of the arc segment to the end of the arc segment.- Since:
- 1.2
- See Also:
- Constant Field Values
-
PIE
public static final int PIE
The closure type for an arc closed by drawing straight line segments from the start of the arc segment to the center of the full ellipse and from that point to the end of the arc segment.- Since:
- 1.2
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
Arc2D
protected Arc2D()
This is an abstract class that cannot be instantiated directly. Type-specific implementation subclasses are available for instantiation and provide a number of formats for storing the information necessary to satisfy the various accessor methods below.This constructor creates an object with a default closure type of
OPEN. It is provided only to enable serialization of subclasses.- See Also:
Arc2D.Float,Arc2D.Double
-
Arc2D
protected Arc2D(int type)
This is an abstract class that cannot be instantiated directly. Type-specific implementation subclasses are available for instantiation and provide a number of formats for storing the information necessary to satisfy the various accessor methods below.- Parameters:
type- The closure type of this arc:OPEN,CHORD, orPIE.- Since:
- 1.2
- See Also:
Arc2D.Float,Arc2D.Double
-
-
Method Detail
-
getAngleStart
public abstract double getAngleStart()
Returns the starting angle of the arc.- Returns:
- A double value that represents the starting angle of the arc in degrees.
- Since:
- 1.2
- See Also:
setAngleStart(double)
-
getAngleExtent
public abstract double getAngleExtent()
Returns the angular extent of the arc.- Returns:
- A double value that represents the angular extent of the arc in degrees.
- Since:
- 1.2
- See Also:
setAngleExtent(double)
-
getArcType
public int getArcType()
- Returns:
- One of the integer constant closure types defined in this class.
- Since:
- 1.2
- See Also:
setArcType(int)
-
getStartPoint
public Point2D getStartPoint()
Returns the starting point of the arc. This point is the intersection of the ray from the center defined by the starting angle and the elliptical boundary of the arc.- Returns:
- A
Point2Dobject representing the x,y coordinates of the starting point of the arc. - Since:
- 1.2
-
getEndPoint
public Point2D getEndPoint()
Returns the ending point of the arc. This point is the intersection of the ray from the center defined by the starting angle plus the angular extent of the arc and the elliptical boundary of the arc.- Returns:
- A
Point2Dobject representing the x,y coordinates of the ending point of the arc. - Since:
- 1.2
-
setArc
public abstract void setArc(double x, double y, double w, double h, double angSt, double angExt, int closure)Sets the location, size, angular extents, and closure type of this arc to the specified double values.- Parameters:
x- The X coordinate of the upper-left corner of the arc.y- The Y coordinate of the upper-left corner of the arc.w- The overall width of the full ellipse of which this arc is a partial section.h- The overall height of the full ellipse of which this arc is a partial section.angSt- The starting angle of the arc in degrees.angExt- The angular extent of the arc in degrees.closure- The closure type for the arc:OPEN,CHORD, orPIE.- Since:
- 1.2
-
setArc
public void setArc(Point2D loc, Dimension2D size, double angSt, double angExt, int closure)
Sets the location, size, angular extents, and closure type of this arc to the specified values.- Parameters:
loc- ThePoint2Drepresenting the coordinates of the upper-left corner of the arc.size- TheDimension2Drepresenting the width and height of the full ellipse of which this arc is a partial section.angSt- The starting angle of the arc in degrees.angExt- The angular extent of the arc in degrees.closure- The closure type for the arc:OPEN,CHORD, orPIE.- Since:
- 1.2
-
setArc
public void setArc(Rectangle2D rect, double angSt, double angExt, int closure)
Sets the location, size, angular extents, and closure type of this arc to the specified values.- Parameters:
rect- The framing rectangle that defines the outer boundary of the full ellipse of which this arc is a partial section.angSt- The starting angle of the arc in degrees.angExt- The angular extent of the arc in degrees.closure- The closure type for the arc:OPEN,CHORD, orPIE.- Since:
- 1.2
-
setArc
public void setArc(Arc2D a)
Sets this arc to be the same as the specified arc.- Parameters:
a- TheArc2Dto use to set the arc's values.- Since:
- 1.2
-
setArcByCenter
public void setArcByCenter(double x, double y, double radius, double angSt, double angExt, int closure)Sets the position, bounds, angular extents, and closure type of this arc to the specified values. The arc is defined by a center point and a radius rather than a framing rectangle for the full ellipse.- Parameters:
x- The X coordinate of the center of the arc.y- The Y coordinate of the center of the arc.radius- The radius of the arc.angSt- The starting angle of the arc in degrees.angExt- The angular extent of the arc in degrees.closure- The closure type for the arc:OPEN,CHORD, orPIE.- Since:
- 1.2
-
setArcByTangent
public void setArcByTangent(Point2D p1, Point2D p2, Point2D p3, double radius)
Sets the position, bounds, and angular extents of this arc to the specified value. The starting angle of the arc is tangent to the line specified by points (p1, p2), the ending angle is tangent to the line specified by points (p2, p3), and the arc has the specified radius.- Parameters:
p1- The first point that defines the arc. The starting angle of the arc is tangent to the line specified by points (p1, p2).p2- The second point that defines the arc. The starting angle of the arc is tangent to the line specified by points (p1, p2). The ending angle of the arc is tangent to the line specified by points (p2, p3).p3- The third point that defines the arc. The ending angle of the arc is tangent to the line specified by points (p2, p3).radius- The radius of the arc.- Since:
- 1.2
-
setAngleStart
public abstract void setAngleStart(double angSt)
Sets the starting angle of this arc to the specified double value.- Parameters:
angSt- The starting angle of the arc in degrees.- Since:
- 1.2
- See Also:
getAngleStart()
-
setAngleExtent
public abstract void setAngleExtent(double angExt)
Sets the angular extent of this arc to the specified double value.- Parameters:
angExt- The angular extent of the arc in degrees.- Since:
- 1.2
- See Also:
getAngleExtent()
-
setAngleStart
public void setAngleStart(Point2D p)
Sets the starting angle of this arc to the angle that the specified point defines relative to the center of this arc. The angular extent of the arc will remain the same.- Parameters:
p- ThePoint2Dthat defines the starting angle.- Since:
- 1.2
- See Also:
getAngleStart()
-
setAngles
public void setAngles(double x1, double y1, double x2, double y2)Sets the starting angle and angular extent of this arc using two sets of coordinates. The first set of coordinates is used to determine the angle of the starting point relative to the arc's center. The second set of coordinates is used to determine the angle of the end point relative to the arc's center. The arc will always be non-empty and extend counterclockwise from the first point around to the second point.- Parameters:
x1- The X coordinate of the arc's starting point.y1- The Y coordinate of the arc's starting point.x2- The X coordinate of the arc's ending point.y2- The Y coordinate of the arc's ending point.- Since:
- 1.2
-
setAngles
public void setAngles(Point2D p1, Point2D p2)
Sets the starting angle and angular extent of this arc using two points. The first point is used to determine the angle of the starting point relative to the arc's center. The second point is used to determine the angle of the end point relative to the arc's center. The arc will always be non-empty and extend counterclockwise from the first point around to the second point.- Parameters:
p1- ThePoint2Dthat defines the arc's starting point.p2- ThePoint2Dthat defines the arc's ending point.- Since:
- 1.2
-
setArcType
public void setArcType(int type)
Sets the closure type of this arc to the specified value:OPEN,CHORD, orPIE.- Parameters:
type- The integer constant that represents the closure type of this arc:OPEN,CHORD, orPIE.- Throws:
IllegalArgumentException- iftypeis not 0, 1, or 2.+- Since:
- 1.2
- See Also:
getArcType()
-
setFrame
public void setFrame(double x, double y, double w, double h)Sets the location and size of the framing rectangle of thisShapeto the specified rectangular values. Note that the arc partially inscribes the framing rectangle of thisRectangularShape.- Specified by:
setFramein classRectangularShape- Parameters:
x- the X coordinate of the upper-left corner of the specified rectangular shapey- the Y coordinate of the upper-left corner of the specified rectangular shapew- the width of the specified rectangular shapeh- the height of the specified rectangular shape- Since:
- 1.2
- See Also:
RectangularShape.getFrame()
-
getBounds2D
public Rectangle2D getBounds2D()
Returns the high-precision framing rectangle of the arc. The framing rectangle contains only the part of thisArc2Dthat is in between the starting and ending angles and contains the pie wedge, if thisArc2Dhas aPIEclosure type.This method differs from the
getBoundsin that thegetBoundsmethod only returns the bounds of the enclosing ellipse of thisArc2Dwithout considering the starting and ending angles of thisArc2D.- Returns:
- the
Rectangle2Dthat represents the arc's framing rectangle. - Since:
- 1.2
- See Also:
Shape.getBounds()
-
makeBounds
protected abstract Rectangle2D makeBounds(double x, double y, double w, double h)
Constructs aRectangle2Dof the appropriate precision to hold the parameters calculated to be the framing rectangle of this arc.- Parameters:
x- The X coordinate of the upper-left corner of the framing rectangle.y- The Y coordinate of the upper-left corner of the framing rectangle.w- The width of the framing rectangle.h- The height of the framing rectangle.- Returns:
- a
Rectangle2Dthat is the framing rectangle of this arc. - Since:
- 1.2
-
containsAngle
public boolean containsAngle(double angle)
Determines whether or not the specified angle is within the angular extents of the arc.- Parameters:
angle- The angle to test.- Returns:
trueif the arc contains the angle,falseif the arc doesn't contain the angle.- Since:
- 1.2
-
contains
public boolean contains(double x, double y)Determines whether or not the specified point is inside the boundary of the arc.- Parameters:
x- The X coordinate of the point to test.y- The Y coordinate of the point to test.- Returns:
trueif the point lies within the bound of the arc,falseif the point lies outside of the arc's bounds.- Since:
- 1.2
-
intersects
public boolean intersects(double x, double y, double w, double h)Determines whether or not the interior of the arc intersects the interior of the specified rectangle.- Parameters:
x- The X coordinate of the rectangle's upper-left corner.y- The Y coordinate of the rectangle's upper-left corner.w- The width of the rectangle.h- The height of the rectangle.- Returns:
trueif the arc intersects the rectangle,falseif the arc doesn't intersect the rectangle.- Since:
- 1.2
- See Also:
Area
-
contains
public boolean contains(double x, double y, double w, double h)Determines whether or not the interior of the arc entirely contains the specified rectangle.- Parameters:
x- The X coordinate of the rectangle's upper-left corner.y- The Y coordinate of the rectangle's upper-left corner.w- The width of the rectangle.h- The height of the rectangle.- Returns:
trueif the arc contains the rectangle,falseif the arc doesn't contain the rectangle.- Since:
- 1.2
- See Also:
Area,Shape.intersects(double, double, double, double)
-
contains
public boolean contains(Rectangle2D r)
Determines whether or not the interior of the arc entirely contains the specified rectangle.- Specified by:
containsin interfaceShape- Overrides:
containsin classRectangularShape- Parameters:
r- TheRectangle2Dto test.- Returns:
trueif the arc contains the rectangle,falseif the arc doesn't contain the rectangle.- Since:
- 1.2
- See Also:
Shape.contains(double, double, double, double)
-
getPathIterator
public PathIterator getPathIterator(AffineTransform at)
Returns an iteration object that defines the boundary of the arc. This iterator is multithread safe.Arc2Dguarantees that modifications to the geometry of the arc do not affect any iterations of that geometry that are already in process.- Parameters:
at- an optionalAffineTransformto be applied to the coordinates as they are returned in the iteration, or null if the untransformed coordinates are desired.- Returns:
- A
PathIteratorthat defines the arc's boundary. - Since:
- 1.2
-
hashCode
public int hashCode()
Returns the hashcode for thisArc2D.- Overrides:
hashCodein classObject- Returns:
- the hashcode for this
Arc2D. - Since:
- 1.6
- See Also:
Object.equals(java.lang.Object)
-
equals
public boolean equals(Object obj)
Determines whether or not the specifiedObjectis equal to thisArc2D. The specifiedObjectis equal to thisArc2Dif it is an instance ofArc2Dand if its location, size, arc extents and type are the same as thisArc2D.- Overrides:
equalsin classObject- Parameters:
obj- anObjectto be compared with thisArc2D.- Returns:
trueifobjis an instance ofArc2Dand has the same values;falseotherwise.- Since:
- 1.6
- See Also:
Object.hashCode()
-
-