This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


java.awt
interface Shape

All Known Implementing Classes:
Area, CubicCurve2D, CubicCurve2D.Double, CubicCurve2D.Float, Line2D, Line2D.Double, Line2D.Float, Path2D, Path2D.Double, Path2D.Float, GeneralPath, Polygon, QuadCurve2D, QuadCurve2D.Double, QuadCurve2D.Float, Rectangle, DefaultCaret, BasicTextUI.BasicCaret, RectangularShape, Arc2D, Ellipse2D, Rectangle2D, RoundRectangle2D, Arc2D.Double, Arc2D.Float, Ellipse2D.Double, Ellipse2D.Float, Rectangle2D.Double, Rectangle2D.Float, RoundRectangle2D.Double, RoundRectangle2D.Float

Most common way to construct:

GlyphVector gv = …;

Shape ashape = gv.getGlyphOutline(0);

Based on 9 examples


public interface Shape

The Shape interface provides definitions for objects that represent some form of geometric shape. The Shape is described by a {@link PathIterator} object, which can express the outline of the Shape as well as a rule for determining how the outline divides the 2D plane into interior and exterior points. Each Shape object provides callbacks to get the bounding box of the geometry, determine whether points or rectangles lie partly or entirely within the interior of the Shape, and retrieve a PathIterator object that describes the trajectory path of the Shape outline.

Definition of insideness: A point is considered to lie inside a Shape if and only if:

The contains and intersects methods consider the interior of a Shape to be the area it encloses as if it were filled. This means that these methods consider unclosed shapes to be implicitly closed for the purpose of determining if a shape contains or intersects a rectangle or if a shape contains a point.


Method Summary
 boolean
contains(double x, double y)

          Tests if the specified coordinates are inside the boundary of the Shape.
 boolean
contains(double x, double y, double w, double h)

          Tests if the interior of the Shape entirely contains the specified rectangular area.
 boolean

          Tests if a specified java.awt.geom.Point2D is inside the boundary of the Shape.
 boolean

          Tests if the interior of the Shape entirely contains the specified Rectangle2D.
 Rectangle

          Returns an integer java.awt.Rectangle that completely encloses the Shape.
 Rectangle2D

          Returns a high precision and more accurate bounding box of the Shape than the getBounds method.
 PathIterator

          Returns an iterator object that iterates along the Shape boundary and provides access to the geometry of the Shape outline.
 PathIterator
getPathIterator(AffineTransform at, double flatness)

          Returns an iterator object that iterates along the Shape boundary and provides access to a flattened view of the Shape outline geometry.
 boolean
intersects(double x, double y, double w, double h)

          Tests if the interior of the Shape intersects the interior of a specified rectangular area.
 boolean

          Tests if the interior of the Shape intersects the interior of a specified Rectangle2D.
 

Method Detail

contains

public boolean contains(double x,
                        double y)
Tests if the specified coordinates are inside the boundary of the Shape.

Parameters:
x - the specified X coordinate to be tested
y - the specified Y coordinate to be tested
Returns:
true if the specified coordinates are inside the Shape boundary; false otherwise.

contains

public boolean contains(double x,
                        double y,
                        double w,
                        double h)
Tests if the interior of the Shape entirely contains the specified rectangular area. All coordinates that lie inside the rectangular area must lie within the Shape for the entire rectanglar area to be considered contained within the Shape.

The {@code Shape.contains()} method allows a {@code Shape} implementation to conservatively return {@code false} when:

This means that for some {@code Shapes} this method might return {@code false} even though the {@code Shape} contains the rectangular area. The {@link java.awt.geom.Area Area} class performs more accurate geometric computations than most {@code Shape} objects and therefore can be used if a more precise answer is required.

Parameters:
x - the X coordinate of the upper-left corner of the specified rectangular area
y - the Y coordinate of the upper-left corner of the specified rectangular area
w - the width of the specified rectangular area
h - the height of the specified rectangular area
Returns:
true if the interior of the Shape entirely contains the specified rectangular area; false otherwise or, if the Shape contains the rectangular area and the intersects method returns true and the containment calculations would be too expensive to perform.

contains

public boolean contains(Point2D p)
Tests if a specified {@link Point2D} is inside the boundary of the Shape.

Parameters:
p - the specified Point2D to be tested
Returns:
true if the specified Point2D is inside the boundary of the Shape; false otherwise.

contains

public boolean contains(Rectangle2D r)
Tests if the interior of the Shape entirely contains the specified Rectangle2D. The {@code Shape.contains()} method allows a {@code Shape} implementation to conservatively return {@code false} when: This means that for some {@code Shapes} this method might return {@code false} even though the {@code Shape} contains the {@code Rectangle2D}. The {@link java.awt.geom.Area Area} class performs more accurate geometric computations than most {@code Shape} objects and therefore can be used if a more precise answer is required.

Parameters:
r - The specified Rectangle2D
Returns:
true if the interior of the Shape entirely contains the Rectangle2D; false otherwise or, if the Shape contains the Rectangle2D and the intersects method returns true and the containment calculations would be too expensive to perform.

getBounds

public Rectangle getBounds()
Returns an integer {@link Rectangle} that completely encloses the Shape. Note that there is no guarantee that the returned Rectangle is the smallest bounding box that encloses the Shape, only that the Shape lies entirely within the indicated Rectangle. The returned Rectangle might also fail to completely enclose the Shape if the Shape overflows the limited range of the integer data type. The getBounds2D method generally returns a tighter bounding box due to its greater flexibility in representation.

Returns:
an integer Rectangle that completely encloses the Shape.

getBounds2D

public Rectangle2D getBounds2D()
Returns a high precision and more accurate bounding box of the Shape than the getBounds method. Note that there is no guarantee that the returned {@link Rectangle2D} is the smallest bounding box that encloses the Shape, only that the Shape lies entirely within the indicated Rectangle2D. The bounding box returned by this method is usually tighter than that returned by the getBounds method and never fails due to overflow problems since the return value can be an instance of the Rectangle2D that uses double precision values to store the dimensions.

Returns:
an instance of Rectangle2D that is a high-precision bounding box of the Shape.

getPathIterator

public PathIterator getPathIterator(AffineTransform at)
Returns an iterator object that iterates along the Shape boundary and provides access to the geometry of the Shape outline. If an optional {@link AffineTransform} is specified, the coordinates returned in the iteration are transformed accordingly.

Each call to this method returns a fresh PathIterator object that traverses the geometry of the Shape object independently from any other PathIterator objects in use at the same time.

It is recommended, but not guaranteed, that objects implementing the Shape interface isolate iterations that are in process from any changes that might occur to the original object's geometry during such iterations.

Parameters:
at - an optional AffineTransform to be applied to the coordinates as they are returned in the iteration, or null if untransformed coordinates are desired
Returns:
a new PathIterator object, which independently traverses the geometry of the Shape.

getPathIterator

public PathIterator getPathIterator(AffineTransform at,
                                    double flatness)
Returns an iterator object that iterates along the Shape boundary and provides access to a flattened view of the Shape outline geometry.

Only SEG_MOVETO, SEG_LINETO, and SEG_CLOSE point types are returned by the iterator.

If an optional AffineTransform is specified, the coordinates returned in the iteration are transformed accordingly.

The amount of subdivision of the curved segments is controlled by the flatness parameter, which specifies the maximum distance that any point on the unflattened transformed curve can deviate from the returned flattened path segments. Note that a limit on the accuracy of the flattened path might be silently imposed, causing very small flattening parameters to be treated as larger values. This limit, if there is one, is defined by the particular implementation that is used.

Each call to this method returns a fresh PathIterator object that traverses the Shape object geometry independently from any other PathIterator objects in use at the same time.

It is recommended, but not guaranteed, that objects implementing the Shape interface isolate iterations that are in process from any changes that might occur to the original object's geometry during such iterations.

Parameters:
at - an optional AffineTransform to be applied to the coordinates as they are returned in the iteration, or null if untransformed coordinates are desired
flatness - the maximum distance that the line segments used to approximate the curved segments are allowed to deviate from any point on the original curve
Returns:
a new PathIterator that independently traverses a flattened view of the geometry of the Shape.

intersects

public boolean intersects(double x,
                          double y,
                          double w,
                          double h)
Tests if the interior of the Shape intersects the interior of a specified rectangular area. The rectangular area is considered to intersect the Shape if any point is contained in both the interior of the Shape and the specified rectangular area.

The {@code Shape.intersects()} method allows a {@code Shape} implementation to conservatively return {@code true} when:

This means that for some {@code Shapes} this method might return {@code true} even though the rectangular area does not intersect the {@code Shape}. The {@link java.awt.geom.Area Area} class performs more accurate computations of geometric intersection than most {@code Shape} objects and therefore can be used if a more precise answer is required.

Parameters:
x - the X coordinate of the upper-left corner of the specified rectangular area
y - the Y coordinate of the upper-left corner of the specified rectangular area
w - the width of the specified rectangular area
h - the height of the specified rectangular area
Returns:
true if the interior of the Shape and the interior of the rectangular area intersect, or are both highly likely to intersect and intersection calculations would be too expensive to perform; false otherwise.

intersects

public boolean intersects(Rectangle2D r)
Tests if the interior of the Shape intersects the interior of a specified Rectangle2D. The {@code Shape.intersects()} method allows a {@code Shape} implementation to conservatively return {@code true} when: This means that for some {@code Shapes} this method might return {@code true} even though the {@code Rectangle2D} does not intersect the {@code Shape}. The {@link java.awt.geom.Area Area} class performs more accurate computations of geometric intersection than most {@code Shape} objects and therefore can be used if a more precise answer is required.

Parameters:
r - the specified Rectangle2D
Returns:
true if the interior of the Shape and the interior of the specified Rectangle2D intersect, or are both highly likely to intersect and intersection calculations would be too expensive to perform; false otherwise.


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.