java.awt.geom
Class GeneralPathIterator

java.lang.Object
  java.awt.geom.GeneralPathIterator

All Implemented Interfaces:

PathIterator

class GeneralPathIterator

extends Object

implements PathIterator

This class represents the iterator for General Paths. It can be used to retrieve all of the elements in a GeneralPath. The GeneralPath.getPathIterator(java.awt.geom.AffineTransform) method is used to create a GeneralPathIterator for a particular GeneralPath. The iterator can be used to iterator the path only once. Subsequent iterations require a new iterator.

Author:

Jim Graham

See Also:

GeneralPath

Field Summary

(package private) AffineTransform	affine
private static int[]	curvesize
(package private) GeneralPath	path
(package private) int	pointIdx
(package private) int	typeIdx

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

(package private)	GeneralPathIterator(GeneralPath path) Constructs an iterator given a GeneralPath.
(package private)	GeneralPathIterator(GeneralPath path, AffineTransform at) Constructs an iterator given a GeneralPath and an optional AffineTransform.

Method Summary

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.
int	getWindingRule() Return the winding rule for determining the interior of the path.
boolean	isDone() Tests if there are more points to read.
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

Field Detail

typeIdx

int typeIdx

pointIdx

int pointIdx

path

GeneralPath path

affine

AffineTransform affine

curvesize

private static final int[] curvesize

Constructor Detail

GeneralPathIterator

GeneralPathIterator(GeneralPath path)

Constructs an iterator given a GeneralPath.

See Also:

GeneralPath.getPathIterator(java.awt.geom.AffineTransform)

GeneralPathIterator

GeneralPathIterator(GeneralPath path,
                    AffineTransform at)

Constructs an iterator given a GeneralPath and an optional AffineTransform.

See Also:

GeneralPath.getPathIterator(java.awt.geom.AffineTransform)

Method Detail

getWindingRule

public int getWindingRule()

Return 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

isDone

public boolean isDone()

Tests if there are more points to read.

Specified by:

isDone in interface PathIterator

Returns:

true if there are more points to read

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

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 may 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 will return one point, SEG_QUADTO will return two points, SEG_CUBICTO will return 3 points and SEG_CLOSE will 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(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 may 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 will return one point, SEG_QUADTO will return two points, SEG_CUBICTO will return 3 points and SEG_CLOSE will 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