Liking cljdoc? Tell your friends :D

jdk.awt.geom.Arc2D

Arc2D is 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, or PIE).

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.

Arc2D is 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, or PIE).


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.
raw docstring

*-chordclj

Static Constant.

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.

type: int

Static Constant.

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.

type: int
raw docstring

*-openclj

Static Constant.

The closure type for an open arc with no path segments connecting the two ends of the arc segment.

type: int

Static Constant.

The closure type for an open arc with no path segments
 connecting the two ends of the arc segment.

type: int
raw docstring

*-pieclj

Static Constant.

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.

type: int

Static Constant.

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.

type: int
raw docstring

containsclj

(contains this r)
(contains this x y)
(contains this x y w h)

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

x - The X coordinate of the rectangle's upper-left corner. - double y - The Y coordinate of the rectangle's upper-left corner. - double w - The width of the rectangle. - double h - The height of the rectangle. - double

returns: true if the arc contains the rectangle, false if the arc doesn't contain the rectangle. - boolean

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

x - The X coordinate of the rectangle's upper-left corner. - `double`
y - The Y coordinate of the rectangle's upper-left corner. - `double`
w - The width of the rectangle. - `double`
h - The height of the rectangle. - `double`

returns: true if the arc contains the rectangle,
 false if the arc doesn't contain the rectangle. - `boolean`
raw docstring

contains-angleclj

(contains-angle this angle)

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

angle - The angle to test. - double

returns: true if the arc contains the angle, false if the arc doesn't contain the angle. - boolean

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

angle - The angle to test. - `double`

returns: true if the arc contains the angle,
 false if the arc doesn't contain the angle. - `boolean`
raw docstring

equalsclj

(equals this 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.

obj - an Object to be compared with this Arc2D. - java.lang.Object

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

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.

obj - an Object to be compared with this Arc2D. - `java.lang.Object`

returns: true if obj is an instance
          of Arc2D and has the same values;
          false otherwise. - `boolean`
raw docstring

get-angle-extentclj

(get-angle-extent this)

Returns the angular extent of the arc.

returns: A double value that represents the angular extent of the arc in degrees. - double

Returns the angular extent of the arc.

returns: A double value that represents the angular extent
 of the arc in degrees. - `double`
raw docstring

get-angle-startclj

(get-angle-start this)

Returns the starting angle of the arc.

returns: A double value that represents the starting angle of the arc in degrees. - double

Returns the starting angle of the arc.

returns: A double value that represents the starting angle
 of the arc in degrees. - `double`
raw docstring

get-arc-typeclj

(get-arc-type this)

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

returns: One of the integer constant closure types defined in this class. - int

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

returns: One of the integer constant closure types defined
 in this class. - `int`
raw docstring

get-bounds-2-dclj

(get-bounds-2-d this)

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.

returns: the Rectangle2D that represents the arc's framing rectangle. - java.awt.geom.Rectangle2D

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.

returns: the Rectangle2D that represents the arc's
 framing rectangle. - `java.awt.geom.Rectangle2D`
raw docstring

get-end-pointclj

(get-end-point this)

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. - java.awt.geom.Point2D

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. - `java.awt.geom.Point2D`
raw docstring

get-path-iteratorclj

(get-path-iterator this at)

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.

at - an optional AffineTransform to be applied to the coordinates as they are returned in the iteration, or null if the untransformed coordinates are desired. - java.awt.geom.AffineTransform

returns: A PathIterator that defines the arc's boundary. - java.awt.geom.PathIterator

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.

at - an optional AffineTransform to be applied to the coordinates as they are returned in the iteration, or null if the untransformed coordinates are desired. - `java.awt.geom.AffineTransform`

returns: A PathIterator that defines the arc's boundary. - `java.awt.geom.PathIterator`
raw docstring

get-start-pointclj

(get-start-point this)

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. - java.awt.geom.Point2D

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. - `java.awt.geom.Point2D`
raw docstring

hash-codeclj

(hash-code this)

Returns the hashcode for this Arc2D.

returns: the hashcode for this Arc2D. - int

Returns the hashcode for this Arc2D.

returns: the hashcode for this Arc2D. - `int`
raw docstring

intersectsclj

(intersects this x y w h)

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

x - The X coordinate of the rectangle's upper-left corner. - double y - The Y coordinate of the rectangle's upper-left corner. - double w - The width of the rectangle. - double h - The height of the rectangle. - double

returns: true if the arc intersects the rectangle, false if the arc doesn't intersect the rectangle. - boolean

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

x - The X coordinate of the rectangle's upper-left corner. - `double`
y - The Y coordinate of the rectangle's upper-left corner. - `double`
w - The width of the rectangle. - `double`
h - The height of the rectangle. - `double`

returns: true if the arc intersects the rectangle,
 false if the arc doesn't intersect the rectangle. - `boolean`
raw docstring

set-angle-extentclj

(set-angle-extent this ang-ext)

Sets the angular extent of this arc to the specified double value.

ang-ext - The angular extent of the arc in degrees. - double

Sets the angular extent of this arc to the specified double
 value.

ang-ext - The angular extent of the arc in degrees. - `double`
raw docstring

set-angle-startclj

(set-angle-start this ang-st)

Sets the starting angle of this arc to the specified double value.

ang-st - The starting angle of the arc in degrees. - double

Sets the starting angle of this arc to the specified double
 value.

ang-st - The starting angle of the arc in degrees. - `double`
raw docstring

set-anglesclj

(set-angles this p-1 p-2)
(set-angles this x-1 y-1 x-2 y-2)

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.

x-1 - The X coordinate of the arc's starting point. - double y-1 - The Y coordinate of the arc's starting point. - double x-2 - The X coordinate of the arc's ending point. - double y-2 - The Y coordinate of the arc's ending point. - double

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.

x-1 - The X coordinate of the arc's starting point. - `double`
y-1 - The Y coordinate of the arc's starting point. - `double`
x-2 - The X coordinate of the arc's ending point. - `double`
y-2 - The Y coordinate of the arc's ending point. - `double`
raw docstring

set-arcclj

(set-arc this a)
(set-arc this rect ang-st ang-ext closure)
(set-arc this loc size ang-st ang-ext closure)
(set-arc this x y w h ang-st ang-ext closure)

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

x - The X coordinate of the upper-left corner of the arc. - double y - The Y coordinate of the upper-left corner of the arc. - double w - The overall width of the full ellipse of which this arc is a partial section. - double h - The overall height of the full ellipse of which this arc is a partial section. - double ang-st - The starting angle of the arc in degrees. - double ang-ext - The angular extent of the arc in degrees. - double closure - The closure type for the arc: OPEN, CHORD, or PIE. - int

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

x - The X coordinate of the upper-left corner of the arc. - `double`
y - The Y coordinate of the upper-left corner of the arc. - `double`
w - The overall width of the full ellipse of which this arc is a partial section. - `double`
h - The overall height of the full ellipse of which this arc is a partial section. - `double`
ang-st - The starting angle of the arc in degrees. - `double`
ang-ext - The angular extent of the arc in degrees. - `double`
closure - The closure type for the arc: OPEN, CHORD, or PIE. - `int`
raw docstring

set-arc-by-centerclj

(set-arc-by-center this x y radius ang-st ang-ext 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.

x - The X coordinate of the center of the arc. - double y - The Y coordinate of the center of the arc. - double radius - The radius of the arc. - double ang-st - The starting angle of the arc in degrees. - double ang-ext - The angular extent of the arc in degrees. - double closure - The closure type for the arc: OPEN, CHORD, or PIE. - int

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.

x - The X coordinate of the center of the arc. - `double`
y - The Y coordinate of the center of the arc. - `double`
radius - The radius of the arc. - `double`
ang-st - The starting angle of the arc in degrees. - `double`
ang-ext - The angular extent of the arc in degrees. - `double`
closure - The closure type for the arc: OPEN, CHORD, or PIE. - `int`
raw docstring

set-arc-by-tangentclj

(set-arc-by-tangent this p-1 p-2 p-3 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.

p-1 - The first point that defines the arc. The starting angle of the arc is tangent to the line specified by points (p1, p2). - java.awt.geom.Point2D p-2 - 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). - java.awt.geom.Point2D p-3 - The third point that defines the arc. The ending angle of the arc is tangent to the line specified by points (p2, p3). - java.awt.geom.Point2D radius - The radius of the arc. - double

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.

p-1 - The first point that defines the arc. The starting angle of the arc is tangent to the line specified by points (p1, p2). - `java.awt.geom.Point2D`
p-2 - 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). - `java.awt.geom.Point2D`
p-3 - The third point that defines the arc. The ending angle of the arc is tangent to the line specified by points (p2, p3). - `java.awt.geom.Point2D`
radius - The radius of the arc. - `double`
raw docstring

set-arc-typeclj

(set-arc-type this type)

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

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

throws: java.lang.IllegalArgumentException - if type is not 0, 1, or 2.+

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

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

throws: java.lang.IllegalArgumentException - if type is not 0, 1, or 2.+
raw docstring

set-frameclj

(set-frame this x y w 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.

x - the X coordinate of the upper-left corner of the specified rectangular shape - double y - the Y coordinate of the upper-left corner of the specified rectangular shape - double w - the width of the specified rectangular shape - double h - the height of the specified rectangular shape - double

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.

x - the X coordinate of the upper-left corner of the specified rectangular shape - `double`
y - the Y coordinate of the upper-left corner of the specified rectangular shape - `double`
w - the width of the specified rectangular shape - `double`
h - the height of the specified rectangular shape - `double`
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close