Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Java Platform 1.2
Beta 4

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Class java.awt.geom.Arc2D

java.lang.Object
  |
  +--java.awt.geom.RectangularShape
        |
        +--java.awt.geom.Arc2D

Direct Known Subclasses:

Arc2D.Double, Arc2D.Float

public abstract class Arc2D

extends RectangularShape

An arc defined by a bounding rectangle, start angle and angular extent, and a closure type (one of OPEN, CHORD, or PIE). The bounding rectangle defines the outer boundary of the full ellipse of which this arc is a partial section. The angles are specified relative to the non-square extents of the bounding rectangle such that 45 degrees always falls on the line from the center of the ellipse to the upper right corner of the bounding rectangle. As a result, if the bounding rectangle is noticeably longer in 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 bounds.

This class is only the abstract superclass for all objects which store a 2D arc. The actual storage representation of the coordinates is left to the subclass.

Inner Class Summary

static	Arc2D.Double An arc specified in double precision,
static	Arc2D.Float An arc specified in float precision,

Field Summary

static int	CHORD The closure type for an arc closed by drawing a straight line segment from the start to the end of the arc segment.
static int	OPEN The closure type for an open arc with no path segments connecting the two ends of the arc segment.
static 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 back to the end of the arc segment.

Constructor Summary

Arc2D(int type)
This is an abstract class that cannot be instantiated directly.

Method Summary

boolean	contains(double x, double y, double w, double h) Test if the interior of the Shape entirely contains the given set of rectangular coordinates.
boolean	contains(double x, double y) Test if a given Point is inside the boundary of the shape.
boolean	contains(Rectangle2D r) Test if the interior of the Shape entirely contains the given Rectangle.
boolean	containsAngle(double angle) Tests if a given angle is within the angular extents of the arc.
abstract double	getAngleExtent() Returns the arc length (angular extent) of the arc (in degrees).
abstract double	getAngleStart() Returns the starting angle of the arc (in degrees).
int	getArcType() Returns the arc closure type of the arc.
Rectangle2D	getBounds2D() Return the high precision bounding box of the shape.
Point2D	getEndPoint() Returns the ending point of the arc.
PathIterator	getPathIterator(AffineTransform at) Return an iteration object that defines the boundary of the shape.
Point2D	getStartPoint() Returns the starting point of the arc.
boolean	intersects(double x, double y, double w, double h) Test if the interior of the Shape intersects the interior of a given Rectangle.
protected abstract Rectangle2D	makeBounds(double x, double y, double w, double h) Construct a rectangle object of the appropriate precision to hold the parameters calculated to be the bounding box of this arc.
abstract void	setAngleExtent(double angExt) Sets the angular extent of this arc to the specified double value (in degrees).
void	setAngles(double x1, double y1, double x2, double y2) Sets the angular extents of this arc to the angles that the specified point coordinates define relative to the center of this arc.
void	setAngles(Point2D p1, Point2D p2) Sets the angular extents of this arc to the angles that the specified Point objects define relative to the center of this arc.
abstract void	setAngleStart(double angSt) Sets the starting angle of this arc to the specified double value (in degrees).
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.
void	setArc(Arc2D a) Sets this arc to be the same as the specified Arc.
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.
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 Point and Dimension and double values.
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 Rectangle and double values.
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 double values based on a center point and a radius rather than a bounding box for the full ellipse.
void	setArcByTangent(Point2D p1, Point2D p2, Point2D p3, double radius) Sets the position, bounds, and angular extents of this arc so that the starting angle is tangent to the line specified by points (p1, p2) and the ending angle is tangent to the line specified by points (p2, p3) with the given radius.
void	setArcType(int type) Sets the closure type of this arc to the specified value.
void	setFrame(double x, double y, double w, double h) Sets the location and size of the outer bounds of this shape to the specified rectangular values.

Methods inherited from 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

Methods inherited from class java.lang.Object

equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait

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.

CHORD

public static final int CHORD

The closure type for an arc closed by drawing a straight line segment from the start to the end of the arc segment.

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 back to the end of the arc segment.

Constructor Detail

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

See Also:

OPEN, CHORD, PIE, Arc2D.Float, Arc2D.Double

Method Detail

getAngleStart

public abstract double getAngleStart()

Returns the starting angle of the arc (in degrees).

getAngleExtent

public abstract double getAngleExtent()

Returns the arc length (angular extent) of the arc (in degrees).

getArcType

public int getArcType()

Returns the arc closure type of the arc.

See Also:

OPEN, CHORD, PIE

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.

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.

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.

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 Point and Dimension and double values.

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 Rectangle and double values.

setArc

public void setArc(Arc2D a)

Sets this arc to be the same as the specified Arc.

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 double values based on a center point and a radius rather than a bounding box for the full ellipse.

setArcByTangent

public void setArcByTangent(Point2D p1,
                            Point2D p2,
                            Point2D p3,
                            double radius)

Sets the position, bounds, and angular extents of this arc so that the starting angle is tangent to the line specified by points (p1, p2) and the ending angle is tangent to the line specified by points (p2, p3) with the given radius.

setAngleStart

public abstract void setAngleStart(double angSt)

Sets the starting angle of this arc to the specified double value (in degrees).

setAngleExtent

public abstract void setAngleExtent(double angExt)

Sets the angular extent of this arc to the specified double value (in degrees).

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.

setAngles

public void setAngles(double x1,
                      double y1,
                      double x2,
                      double y2)

Sets the angular extents of this arc to the angles that the specified point coordinates define relative to the center of this arc. The arc will always be non-empty and extend counterclockwise from the first point around to the second point.

setAngles

public void setAngles(Point2D p1,
                      Point2D p2)

Sets the angular extents of this arc to the angles that the specified Point objects define relative to the center of this arc. The arc will always be non-empty and extend counterclockwise from the first point around to the second point.

setArcType

public void setArcType(int type)

Sets the closure type of this arc to the specified value.

See Also:

OPEN, CHORD, PIE

setFrame

public void setFrame(double x,
                     double y,
                     double w,
                     double h)

Sets the location and size of the outer bounds of this shape to the specified rectangular values.

Overrides:

setFrame in class RectangularShape

getBounds2D

public Rectangle2D getBounds2D()

Return the high precision bounding box of the shape.

makeBounds

protected abstract Rectangle2D makeBounds(double x,
                                          double y,
                                          double w,
                                          double h)

Construct a rectangle object of the appropriate precision to hold the parameters calculated to be the bounding box of this arc.

containsAngle

public boolean containsAngle(double angle)

Tests if a given angle is within the angular extents of the arc.

contains

public boolean contains(double x,
                        double y)

Test if a given Point is inside the boundary of the shape.

intersects

public boolean intersects(double x,
                          double y,
                          double w,
                          double h)

Test if the interior of the Shape intersects the interior of a given Rectangle.

contains

public boolean contains(double x,
                        double y,
                        double w,
                        double h)

Test if the interior of the Shape entirely contains the given set of rectangular coordinates.

contains

public boolean contains(Rectangle2D r)

Test if the interior of the Shape entirely contains the given Rectangle.

Overrides:

contains in class RectangularShape

getPathIterator

public PathIterator getPathIterator(AffineTransform at)

Return an iteration object that defines the boundary of the shape.