org.jdesktop.swingx.geom
Class Star2D

java.lang.Object
  extended by org.jdesktop.swingx.geom.Star2D
All Implemented Interfaces:
Shape

public class Star2D
extends Object
implements Shape

This class provides a star shape. A star is defined by two radii and a number of branches. Each branch spans between the two radii. The inner radius is the distance between the center of the star and the origin of the branches. The outer radius is the distance between the center of the star and the tips of the branches.


Constructor Summary
Star2D(double x, double y, double innerRadius, double outerRadius, int branchesCount)
          Creates a new star whose center is located at the specified x and y coordinates.
 
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 contains(Point2D p)
          Tests if a specified Point2D is inside the boundary of the Shape.
 boolean contains(Rectangle2D r)
          Tests if the interior of the Shape entirely contains the specified Rectangle2D.
 Rectangle getBounds()
          Returns an integer Rectangle that completely encloses the Shape.
 Rectangle2D getBounds2D()
          Returns a high precision and more accurate bounding box of the Shape than the getBounds method.
 int getBranchesCount()
          Returns the number of branches of the star.
 double getInnerRadius()
          Returns the distance between the center of the star and the origin of the branches.
 double getOuterRadius()
          Returns the distance between the center of the star and the tips of the branches.
 PathIterator getPathIterator(AffineTransform at)
          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.
 double getX()
          Returns the location of the center of star.
 double getY()
          Returns the location of the center of star.
 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 intersects(Rectangle2D r)
          Tests if the interior of the Shape intersects the interior of a specified Rectangle2D.
 void setBranchesCount(int branchesCount)
          Sets the number branches of the star.
 void setInnerRadius(double innerRadius)
          Sets the inner radius of the star, that is the distance between its center and the origin of the branches.
 void setOuterRadius(double outerRadius)
          Sets the outer radius of the star, that is the distance between its center and the tips of the branches.
 void setX(double x)
          Sets location of the center of the star.
 void setY(double y)
          Sets the location of the center of the star.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Star2D

public Star2D(double x,
              double y,
              double innerRadius,
              double outerRadius,
              int branchesCount)

Creates a new star whose center is located at the specified x and y coordinates. The number of branches and their length can be specified.

Parameters:
x - the location of the star center
y - the location of the star center
innerRadius - the distance between the center of the star and the origin of the branches
outerRadius - the distance between the center of the star and the tip of the branches
branchesCount - the number of branches in this star; must be >= 3
Throws:
IllegalArgumentException - if branchesCount is < 3 or if innerRadius is >= outerRadius
Method Detail

setInnerRadius

public void setInnerRadius(double innerRadius)

Sets the inner radius of the star, that is the distance between its center and the origin of the branches. The inner radius must always be lower than the outer radius.

Parameters:
innerRadius - the distance between the center of the star and the origin of the branches
Throws:
IllegalArgumentException - if the inner radius is >= outer radius

setX

public void setX(double x)

Sets location of the center of the star.

Parameters:
x - the x location of the center of the star

setY

public void setY(double y)

Sets the location of the center of the star.

Parameters:
y - the x location of the center of the star

setOuterRadius

public void setOuterRadius(double outerRadius)

Sets the outer radius of the star, that is the distance between its center and the tips of the branches. The outer radius must always be greater than the inner radius.

Parameters:
outerRadius - the distance between the center of the star and the tips of the branches
Throws:
IllegalArgumentException - if the inner radius is >= outer radius

setBranchesCount

public void setBranchesCount(int branchesCount)

Sets the number branches of the star. A star must always have at least 3 branches.

Parameters:
branchesCount - the number of branches
Throws:
IllegalArgumentException - if branchesCount is <=2

getX

public double getX()

Returns the location of the center of star.

Returns:
the x coordinate of the center of the star

getY

public double getY()

Returns the location of the center of star.

Returns:
the y coordinate of the center of the star

getInnerRadius

public double getInnerRadius()

Returns the distance between the center of the star and the origin of the branches.

Returns:
the inner radius of the star

getOuterRadius

public double getOuterRadius()

Returns the distance between the center of the star and the tips of the branches.

Returns:
the outer radius of the star

getBranchesCount

public int getBranchesCount()

Returns the number of branches of the star.

Returns:
the number of branches, always >= 3

getBounds

public Rectangle getBounds()
Returns an integer 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.

Specified by:
getBounds in interface Shape
Returns:
an integer Rectangle that completely encloses the Shape.
See Also:
Shape.getBounds2D()

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

Specified by:
getBounds2D in interface Shape
Returns:
an instance of Rectangle2D that is a high-precision bounding box of the Shape.
See Also:
Shape.getBounds()

contains

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

Specified by:
contains in interface 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(Point2D p)
Tests if a specified Point2D is inside the boundary of the Shape.

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

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 Shape.intersects() method allows a Shape implementation to conservatively return true when:

  • there is a high probability that the rectangular area and the Shape intersect, but
  • the calculations to accurately determine this intersection are prohibitively expensive.
This means that for some Shapes this method might return true even though the rectangular area does not intersect the Shape. The Area class performs more accurate computations of geometric intersection than most Shape objects and therefore can be used if a more precise answer is required.

Specified by:
intersects in interface Shape
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.
See Also:
Area

intersects

public boolean intersects(Rectangle2D r)
Tests if the interior of the Shape intersects the interior of a specified Rectangle2D. The Shape.intersects() method allows a Shape implementation to conservatively return true when:
  • there is a high probability that the Rectangle2D and the Shape intersect, but
  • the calculations to accurately determine this intersection are prohibitively expensive.
This means that for some Shapes this method might return true even though the Rectangle2D does not intersect the Shape. The Area class performs more accurate computations of geometric intersection than most Shape objects and therefore can be used if a more precise answer is required.

Specified by:
intersects in interface Shape
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.
See Also:
Shape.intersects(double, double, double, double)

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 Shape.contains() method allows a Shape implementation to conservatively return false when:

  • the intersect method returns true and
  • the calculations to determine whether or not the Shape entirely contains the rectangular area are prohibitively expensive.
This means that for some Shapes this method might return false even though the Shape contains the rectangular area. The Area class performs more accurate geometric computations than most Shape objects and therefore can be used if a more precise answer is required.

Specified by:
contains in interface Shape
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.
See Also:
Area, Shape.intersects(double, double, double, double)

contains

public boolean contains(Rectangle2D r)
Tests if the interior of the Shape entirely contains the specified Rectangle2D. The Shape.contains() method allows a Shape implementation to conservatively return false when:
  • the intersect method returns true and
  • the calculations to determine whether or not the Shape entirely contains the Rectangle2D are prohibitively expensive.
This means that for some Shapes this method might return false even though the Shape contains the Rectangle2D. The Area class performs more accurate geometric computations than most Shape objects and therefore can be used if a more precise answer is required.

Specified by:
contains in interface Shape
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.
See Also:
Shape.contains(double, double, double, double)

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

Specified by:
getPathIterator in interface Shape
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.

Specified by:
getPathIterator in interface Shape
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.