com.sun.javafx.geom

Class Arc2D

java.lang.Object

com.sun.javafx.geom.Shape

com.sun.javafx.geom.RectangularShape

com.sun.javafx.geom.Arc2D

public class Arc2D
extends RectangularShape

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.

Version:

10 Feb 1997

Field Summary

Fields

Modifier and Type	Field and Description
static 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.
float	extent The angular extent of the arc in degrees.
float	height The overall height of the full ellipse of which this arc is a partial section (not considering the angular extents).
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 from that point to the end of the arc segment.
float	start The starting angle of the arc in degrees.
float	width The overall width of the full ellipse of which this arc is a partial section (not considering the angular extents).
float	x The X coordinate of the upper-left corner of the framing rectangle of the arc.
float	y The Y coordinate of the upper-left corner of the framing rectangle of the arc.

Fields inherited from class com.sun.javafx.geom.Shape

OUT_BOTTOM, OUT_LEFT, OUT_RIGHT, OUT_TOP, RECT_INTERSECTS

Constructor Summary

Constructors

Constructor and Description
Arc2D() Constructs a new OPEN arc, initialized to location (0, 0), size (0, 0), angular extents (start = 0, extent = 0).
Arc2D(float x, float y, float w, float h, float start, float extent, int type) Constructs a new arc, initialized to the specified location, size, angular extents, and closure type.
Arc2D(int type) Constructs a new arc, initialized to location (0, 0), size (0, 0), angular extents (start = 0, extent = 0), and the specified closure type.

Method Summary

Modifier and Type	Method and Description
boolean	contains(float x, float y) Determines whether or not the specified point is inside the boundary of the arc.
boolean	contains(float x, float y, float w, float h) Determines whether or not the interior of the arc entirely contains the specified rectangle.
boolean	containsAngle(float angle) Determines whether or not the specified angle is within the angular extents of the arc.
Arc2D	copy() Returns a new copy of this Shape instance.
boolean	equals(Object obj) Determines whether or not the specified Object is equal to this Arc2D.
int	getArcType() Returns the arc closure type of the arc: OPEN, CHORD, or PIE.
RectBounds	getBounds() Returns the high-precision framing rectangle of the arc.
Point2D	getEndPoint() Returns the ending point of the arc.
float	getHeight() Returns the height of the framing rectangle in double precision.
PathIterator	getPathIterator(BaseTransform tx) Returns an iteration object that defines the boundary of the arc.
Point2D	getStartPoint() Returns the starting point of the arc.
float	getWidth() Returns the width of the framing rectangle in double precision.
float	getX() Returns the X coordinate of the upper-left corner of the framing rectangle in double precision.
float	getY() Returns the Y coordinate of the upper-left corner of the framing rectangle in double precision.
int	hashCode() Returns the hashcode for this Arc2D.
boolean	intersects(float x, float y, float w, float h) Determines whether or not the interior of the arc intersects the interior of the specified rectangle.
boolean	isEmpty() Determines whether the RectangularShape is empty.
void	setAngles(float x1, float y1, float x2, float y2) Sets the starting angle and angular extent of this arc using two sets of coordinates.
void	setAngles(Point2D p1, Point2D p2) Sets the starting angle and angular extent of this arc using two points.
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.
void	setArc(float x, float y, float w, float h, float angSt, float angExt, int closure)
void	setArc(Point2D loc, Dimension2D size, float angSt, float angExt, int closure) Sets the location, size, angular extents, and closure type of this arc to the specified values.
void	setArcByCenter(float x, float y, float radius, float angSt, float angExt, int closure) Sets the position, bounds, angular extents, and closure type of this arc to the specified values.
void	setArcByTangent(Point2D p1, Point2D p2, Point2D p3, float radius) Sets the position, bounds, and angular extents of this arc to the specified value.
void	setArcType(int type) Sets the closure type of this arc to the specified value: OPEN, CHORD, or PIE.
void	setFrame(float x, float y, float w, float h) Sets the location and size of the framing rectangle of this Shape to the specified rectangular values.

Methods inherited from class com.sun.javafx.geom.RectangularShape

contains, getCenterX, getCenterY, getMaxX, getMaxY, getMinX, getMinY, getPathIterator, setFrame, setFrameFromCenter, setFrameFromCenter, setFrameFromDiagonal, setFrameFromDiagonal, toString

Methods inherited from class com.sun.javafx.geom.Shape

accumulate, accumulateCubic, accumulateCubic, accumulateQuad, contains, intersects, pointCrossingsForCubic, pointCrossingsForLine, pointCrossingsForPath, pointCrossingsForQuad, rectCrossingsForCubic, rectCrossingsForLine, rectCrossingsForPath, rectCrossingsForQuad

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, 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.

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.

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.

See Also:

Constant Field Values

x

public float x

The X coordinate of the upper-left corner of the framing rectangle of the arc.

y

public float y

The Y coordinate of the upper-left corner of the framing rectangle of the arc.

width

public float width

The overall width of the full ellipse of which this arc is a partial section (not considering the angular extents).

height

public float height

The overall height of the full ellipse of which this arc is a partial section (not considering the angular extents).

start

public float start

The starting angle of the arc in degrees.

extent

public float extent

The angular extent of the arc in degrees.

Constructor Detail

Arc2D

public Arc2D()

Constructs a new OPEN arc, initialized to location (0, 0), size (0, 0), angular extents (start = 0, extent = 0).

Arc2D

public Arc2D(int type)

Constructs a new arc, initialized to location (0, 0), size (0, 0), angular extents (start = 0, extent = 0), and the specified closure type.

Parameters:

type - The closure type for the arc: OPEN, CHORD, or PIE.

Arc2D

public Arc2D(float x,
             float y,
             float w,
             float h,
             float start,
             float extent,
             int type)

Constructs a new arc, initialized to the specified location, size, angular extents, and closure type.

Parameters:

x - The X coordinate of the upper-left corner of the arc's framing rectangle.

y - The Y coordinate of the upper-left corner of the arc's framing rectangle.

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.

start - The starting angle of the arc in degrees.

extent - The angular extent of the arc in degrees.

type - The closure type for the arc: OPEN, CHORD, or PIE.

Method Detail

getX

public float getX()

Returns the X coordinate of the upper-left corner of the framing rectangle in double precision.

Specified by:

getX in class RectangularShape

Returns:

the X coordinate of the upper-left corner of the framing rectangle.

getY

public float getY()

Returns the Y coordinate of the upper-left corner of the framing rectangle in double precision.

Specified by:

getY in class RectangularShape

Returns:

the Y coordinate of the upper-left corner of the framing rectangle.

getWidth

public float getWidth()

Returns the width of the framing rectangle in double precision.

Specified by:

getWidth in class RectangularShape

Returns:

the width of the framing rectangle.

getHeight

public float getHeight()

Returns the height of the framing rectangle in double precision.

Specified by:

getHeight in class RectangularShape

Returns:

the height of the framing rectangle.

isEmpty

public boolean isEmpty()

Determines whether the RectangularShape is empty. When the RectangularShape is empty, it encloses no area.

Specified by:

isEmpty in class RectangularShape

Returns:

true if the RectangularShape is empty; false otherwise.

setArc

public void setArc(float x,
                   float y,
                   float w,
                   float h,
                   float angSt,
                   float angExt,
                   int closure)

getArcType

public int getArcType()

Returns the arc closure type of the arc: OPEN, CHORD, or PIE.

Returns:

One of the integer constant closure types defined in this class.

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 Point2D object representing the x,y coordinates of the starting point 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.

Returns:

A Point2D object representing the x,y coordinates of the ending point of the arc.

setArc

public void setArc(Point2D loc,
                   Dimension2D size,
                   float angSt,
                   float angExt,
                   int closure)

Sets the location, size, angular extents, and closure type of this arc to the specified values.

Parameters:

loc - The Point2D representing the coordinates of the upper-left corner of the arc.

size - The Dimension2D representing 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, or PIE.

setArc

public void setArc(Arc2D a)

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

Parameters:

a - The Arc2D to use to set the arc's values.

setArcByCenter

public void setArcByCenter(float x,
                           float y,
                           float radius,
                           float angSt,
                           float 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, or PIE.

setArcByTangent

public void setArcByTangent(Point2D p1,
                            Point2D p2,
                            Point2D p3,
                            float 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.

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 - The Point2D that defines the starting angle.

See Also:

start

setAngles

public void setAngles(float x1,
                      float y1,
                      float x2,
                      float 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.

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 - The Point2D that defines the arc's starting point.

p2 - The Point2D that defines the arc's ending point.

setArcType

public void setArcType(int type)

Sets the closure type of this arc to the specified value: OPEN, CHORD, or PIE.

Parameters:

type - The integer constant that represents the closure type of this arc: OPEN, CHORD, or PIE.

Throws:

IllegalArgumentException - if type is not 0, 1, or 2.+

See Also:

getArcType()

setFrame

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

Sets the location and size of the framing rectangle of this Shape to the specified rectangular values. Note that the arc partially inscribes the framing rectangle of this RectangularShape.

Specified by:

setFrame in class RectangularShape

Parameters:

x - the X coordinate of the upper-left corner of the specified rectangular shape

y - the Y coordinate of the upper-left corner of the specified rectangular shape

w - the width of the specified rectangular shape

h - the height of the specified rectangular shape

See Also:

#getFrame

getBounds

public RectBounds getBounds()

Returns the high-precision framing rectangle of the arc. The framing rectangle contains only the part of this Arc2D that is in between the starting and ending angles and contains the pie wedge, if this Arc2D has a PIE closure type.

This method differs from the getBounds in that the getBounds method only returns the bounds of the enclosing ellipse of this Arc2D without considering the starting and ending angles of this Arc2D.

Overrides:

getBounds in class RectangularShape

Returns:

the RectBounds that represents the arc's framing rectangle.

containsAngle

public boolean containsAngle(float angle)

Determines whether or not the specified angle is within the angular extents of the arc.

Parameters:

angle - The angle to test.

Returns:

true if the arc contains the angle, false if the arc doesn't contain the angle.

contains

public boolean contains(float x,
                        float y)

Determines whether or not the specified point is inside the boundary of the arc.

Specified by:

contains in class Shape

Parameters:

x - The X coordinate of the point to test.

y - The Y coordinate of the point to test.

Returns:

true if the point lies within the bound of the arc, false if the point lies outside of the arc's bounds.

intersects

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

Determines whether or not the interior of the arc intersects the interior of the specified rectangle.

Specified by:

intersects in class Shape

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:

true if the arc intersects the rectangle, false if the arc doesn't intersect the rectangle.

contains

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

Determines whether or not the interior of the arc entirely contains the specified rectangle.

Specified by:

contains in class Shape

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:

true if the arc contains the rectangle, false if the arc doesn't contain the rectangle.

See Also:

Shape.intersects(float, float, float, float)

getPathIterator

public PathIterator getPathIterator(BaseTransform tx)

Returns an iteration object that defines the boundary of the arc. This iterator is multithread safe. Arc2D guarantees that modifications to the geometry of the arc do not affect any iterations of that geometry that are already in process.

Specified by:

getPathIterator in class Shape

Parameters:

tx - an optional BaseTransform to be applied to the coordinates as they are returned in the iteration, or null if the untransformed coordinates are desired.

Returns:

A PathIterator that defines the arc's boundary.

copy

public Arc2D copy()

Description copied from class: Shape

Returns a new copy of this Shape instance.

Specified by:

copy in class Shape

Returns:

a copy of this shape

hashCode

public int hashCode()

Returns the hashcode for this Arc2D.

Overrides:

hashCode in class Object

Returns:

the hashcode for this Arc2D.

equals

public boolean equals(Object obj)

Determines whether or not the specified Object is equal to this Arc2D. The specified Object is equal to this Arc2D if it is an instance of Arc2D and if its location, size, arc extents and type are the same as this Arc2D.

Overrides:

equals in class Object

Parameters:

obj - an Object to be compared with this Arc2D.

Returns:

true if obj is an instance of Arc2D and has the same values; false otherwise.