Module org.jhotdraw8.geom

Package org.jhotdraw8.geom

Class ReversePathIterator

java.lang.Object

org.jhotdraw8.geom.ReversePathIterator

All Implemented Interfaces:

PathIterator

public class ReversePathIterator
extends Object
implements PathIterator

A path iterator which iterates over a path in the reverse direction. This is missing in the java.awt.geom package, although it's quite simple to implement. After initialization the original PathIterator is not used any longer.

There are several static convenience methods to create a reverse path iterator from a shape directly:

• getReversePathIterator(Shape) for reversing the standard path iterator
• getReversePathIterator(Shape, double) for reversing a flattened path iterator
• getReversePathIterator(Shape, AffineTransform) for reversing a transformed path iterator
• getReversePathIterator(Shape, AffineTransform, double) for reversing a transformed flattened path iterator
• getReversePathIterator(Shape, int) for reversing the standard path iterator while explicitly defining a winding rule
• getReversePathIterator(Shape, double, int) for reversing a flattened path iterator while explicitly defining a winding rule
• getReversePathIterator(Shape, AffineTransform, int) for reversing a transformed path iterator while explicitly defining a winding rule
• getReversePathIterator(Shape, AffineTransform, double, int) for reversing a transformed flattened path iterator while explicitly defining a winding rule

References:

Rammi (2005). ReversePathIterator

(c) 2005 Rammi (rammi@caff.de) This code is in the public domain. This usage of this code is allowed without any restrictions. No guarantees are given whatsoever.

caff.de

Field Summary

Fields inherited from interface java.awt.geom.PathIterator

SEG_CLOSE, SEG_CUBICTO, SEG_LINETO, SEG_MOVETO, SEG_QUADTO, WIND_EVEN_ODD, WIND_NON_ZERO

Constructor Summary

Constructors

Constructor	Description
ReversePathIterator(PathIterator original)	Create an inverted path iterator from a standard one, keeping the winding rule.
ReversePathIterator(PathIterator original, int windingRule)	Create an inverted path iterator from a standard one.

Method Summary

Modifier and Type	Method	Description
int	currentSegment(double[] coords)	Returns the coordinates and type of the current path segment in the iteration.
int	currentSegment(float[] coords)	Returns the coordinates and type of the current path segment in the iteration.
static PathIterator	getReversePathIterator(Shape shape)	Get a reverse path iterator for a shape, keeping the shape's winding rule.
static PathIterator	getReversePathIterator(Shape shape, double flatness)	Get a reverse flattened path iterator for a shape, keeping the shape's winding rule.
static PathIterator	getReversePathIterator(Shape shape, double flatness, int windingRule)	Get a reverse flattened path iterator for a shape.
static PathIterator	getReversePathIterator(Shape shape, int windingRule)	Get a reverse path iterator for a shape.
static PathIterator	getReversePathIterator(Shape shape, AffineTransform at)	Get a reverse transformed path iterator for a shape, keeping the shape's winding rule.
static PathIterator	getReversePathIterator(Shape shape, AffineTransform at, double flatness)	Get a reverse transformed flattened path iterator for a shape, keeping the shape's winding rule.
static PathIterator	getReversePathIterator(Shape shape, AffineTransform at, double flatness, int windingRule)	Get a reverse transformed flattened path iterator for a shape.
static PathIterator	getReversePathIterator(Shape shape, AffineTransform at, int windingRule)	Get a reverse transformed path iterator for a shape.
int	getWindingRule()	Returns the winding rule for determining the interior of the path.
boolean	isDone()	Tests if the iteration is complete.
void	next()	Moves the iterator to the next segment of the path forwards along the primary direction of traversal as long as there are more points in that direction.

Methods inherited from class java.lang.Object

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

Constructor Details

ReversePathIterator

public ReversePathIterator(PathIterator original)

Create an inverted path iterator from a standard one, keeping the winding rule.

Parameters:

original - original iterator

ReversePathIterator

public ReversePathIterator(PathIterator original,
 int windingRule)

Create an inverted path iterator from a standard one.

Parameters:

original - original iterator

windingRule - winding rule of newly created iterator

Method Details

getReversePathIterator

public static PathIterator getReversePathIterator(Shape shape)

Get a reverse path iterator for a shape, keeping the shape's winding rule.

Parameters:

shape - shape for which a reverse path iterator is needed

Returns:

reverse path iterator

getReversePathIterator

public static PathIterator getReversePathIterator(Shape shape,
 double flatness)

Get a reverse flattened path iterator for a shape, keeping the shape's winding rule.

Parameters:

shape - shape for which a reverse flattened path iterator is needed

flatness - flatness epsilon

Returns:

reverse flattened path iterator

getReversePathIterator

public static PathIterator getReversePathIterator(Shape shape,
 AffineTransform at)

Get a reverse transformed path iterator for a shape, keeping the shape's winding rule.

Parameters:

shape - shape for which a reverse transformed path iterator is needed

Returns:

reverse transformed path iterator

getReversePathIterator

public static PathIterator getReversePathIterator(Shape shape,
 AffineTransform at,
 double flatness)

Get a reverse transformed flattened path iterator for a shape, keeping the shape's winding rule.

Parameters:

shape - shape for which a reverse transformed flattened path iterator is needed

flatness - flatness epsilon

Returns:

reverse transformed flattened path iterator

getReversePathIterator

public static PathIterator getReversePathIterator(Shape shape,
 int windingRule)

Get a reverse path iterator for a shape.

Parameters:

shape - shape for which a reverse path iterator is needed

windingRule - winding rule of newly created iterator

Returns:

reverse path iterator

getReversePathIterator

public static PathIterator getReversePathIterator(Shape shape,
 double flatness,
 int windingRule)

Get a reverse flattened path iterator for a shape.

Parameters:

shape - shape for which a reverse flattened path iterator is needed

flatness - flatness epsilon

windingRule - winding rule of newly created iterator

Returns:

reverse flattened path iterator

getReversePathIterator

public static PathIterator getReversePathIterator(Shape shape,
 AffineTransform at,
 int windingRule)

Get a reverse transformed path iterator for a shape.

Parameters:

shape - shape for which a reverse transformed path iterator is needed

windingRule - winding rule of newly created iterator

Returns:

reverse transformed path iterator

getReversePathIterator

public static PathIterator getReversePathIterator(Shape shape,
 AffineTransform at,
 double flatness,
 int windingRule)

Get a reverse transformed flattened path iterator for a shape.

Parameters:

shape - shape for which a reverse transformed flattened path iterator is needed

flatness - flatness epsilon

windingRule - winding rule of newly created iterator

Returns:

reverse transformed flattened path iterator

getWindingRule

public int getWindingRule()

Returns the winding rule for determining the interior of the path.

Specified by:

getWindingRule in interface PathIterator

Returns:

the winding rule.

See Also:

• PathIterator.WIND_EVEN_ODD
• PathIterator.WIND_NON_ZERO

next

public void next()

Moves the iterator to the next segment of the path forwards along the primary direction of traversal as long as there are more points in that direction.

Specified by:

next in interface PathIterator

isDone

public boolean isDone()

Tests if the iteration is complete.

Specified by:

isDone in interface PathIterator

Returns:

true if all the segments have been read; false otherwise.

currentSegment

public int currentSegment(double[] coords)

Returns the coordinates and type of the current path segment in the iteration. The return value is the path-segment type: SEG_MOVETO, SEG_LINETO, SEG_QUADTO, SEG_CUBICTO, or SEG_CLOSE. A double array of length 6 must be passed in and can be used to store the coordinates of the point(s). Each point is stored as a pair of double x,y coordinates. SEG_MOVETO and SEG_LINETO types returns one point, SEG_QUADTO returns two points, SEG_CUBICTO returns 3 points and SEG_CLOSE does not return any points.

Specified by:

currentSegment in interface PathIterator

Parameters:

coords - an array that holds the data returned from this method

Returns:

the path-segment type of the current path segment.

See Also:

• PathIterator.SEG_MOVETO
• PathIterator.SEG_LINETO
• PathIterator.SEG_QUADTO
• PathIterator.SEG_CUBICTO
• PathIterator.SEG_CLOSE

currentSegment

public int currentSegment(float[] coords)

Returns the coordinates and type of the current path segment in the iteration. The return value is the path-segment type: SEG_MOVETO, SEG_LINETO, SEG_QUADTO, SEG_CUBICTO, or SEG_CLOSE. A float array of length 6 must be passed in and can be used to store the coordinates of the point(s). Each point is stored as a pair of float x,y coordinates. SEG_MOVETO and SEG_LINETO types returns one point, SEG_QUADTO returns two points, SEG_CUBICTO returns 3 points and SEG_CLOSE does not return any points.

Specified by:

currentSegment in interface PathIterator

Parameters:

coords - an array that holds the data returned from this method

Returns:

the path-segment type of the current path segment.

See Also:

• PathIterator.SEG_MOVETO
• PathIterator.SEG_LINETO
• PathIterator.SEG_QUADTO
• PathIterator.SEG_CUBICTO
• PathIterator.SEG_CLOSE