com.aspose.drawing.drawing2d

Class GraphicsPathIterator

java.lang.Object

com.aspose.drawing.drawing2d.GraphicsPathIterator

All Implemented Interfaces:

com.aspose.ms.System.IDisposable

public final class GraphicsPathIterator
extends Object
implements com.aspose.ms.System.IDisposable

Provides the ability to iterate through subpaths in a GraphicsPath and test the types of shapes contained in each subpath. This class cannot be inherited.

See Also:

IDisposable

Constructor Summary

Constructors

Constructor and Description
GraphicsPathIterator(GraphicsPath path) Initializes a new instance of the GraphicsPathIterator class.

Method Summary

Modifier and Type	Method and Description
int	copyData(PointF[][] points, byte[][] types, int startIndex, int endIndex) Copies the GraphicsPath.PathPoints property and GraphicsPath.PathTypes property arrays of the associated GraphicsPath into the two specified arrays.
void	dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
int	enumerate(PointF[][] points, byte[][] types) Copies the GraphicsPath.PathPoints property and GraphicsPath.PathTypes property arrays of the associated GraphicsPath into the two specified arrays.
int	getCount() Gets the number of points in the path.
int	getSubpathCount() Gets the number of subpaths in the path.
boolean	hasCurve() Indicates whether the path associated with this GraphicsPathIterator contains a curve.
int	nextMarker(GraphicsPath path) This GraphicsPathIterator object has a GraphicsPath object associated with it.
int	nextMarker(int[] startIndex, int[] endIndex) Increments the GraphicsPathIterator to the next marker in the path and returns the start and stop indexes by way of the [out] parameters.
int	nextPathType(byte[] pathType, int[] startIndex, int[] endIndex) Gets the starting index and the ending index of the next group of data points that all have the same type.
int	nextSubpath(GraphicsPath path, boolean[] isClosed) Gets the next figure (subpath) from the associated path of this GraphicsPathIterator.
int	nextSubpath(int[] startIndex, int[] endIndex, boolean[] isClosed) Moves the GraphicsPathIterator to the next subpath in the path.
void	rewind() Rewinds this GraphicsPathIterator to the beginning of its associated path.

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphicsPathIterator

public GraphicsPathIterator(GraphicsPath path)

Initializes a new instance of the GraphicsPathIterator class.

Parameters:

path - The GraphicsPath object for which this helper class is to be initialized.

Method Detail

getCount

public int getCount()

Gets the number of points in the path.

Returns:

the number of points in the path.

getSubpathCount

public int getSubpathCount()

Gets the number of subpaths in the path.

Returns:

the number of subpaths in the path.

dispose

public void dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Specified by:

dispose in interface com.aspose.ms.System.IDisposable

copyData

public int copyData(PointF[][] points,
                    byte[][] types,
                    int startIndex,
                    int endIndex)

Copies the GraphicsPath.PathPoints property and GraphicsPath.PathTypes property arrays of the associated GraphicsPath into the two specified arrays.

Parameters:

points - Upon return, contains an array of System.Drawing.PointF structures that represents the points in the path.

types - Upon return, contains an array of bytes that represents the types of points in the path.

startIndex - Specifies the starting index of the arrays.

endIndex - Specifies the ending index of the arrays.

Returns:

The number of points copied.

enumerate

public int enumerate(PointF[][] points,
                     byte[][] types)

Copies the GraphicsPath.PathPoints property and GraphicsPath.PathTypes property arrays of the associated GraphicsPath into the two specified arrays.

Parameters:

points - Upon return, contains an array of System.Drawing.PointF structures that represents the points in the path.

types - Upon return, contains an array of bytes that represents the types of points in the path.

Returns:

The number of points copied.

hasCurve

public boolean hasCurve()

Indicates whether the path associated with this GraphicsPathIterator contains a curve.

Returns:

This method returns true if the current subpath contains a curve; otherwise, false.

nextMarker

public int nextMarker(int[] startIndex,
                      int[] endIndex)

Increments the GraphicsPathIterator to the next marker in the path and returns the start and stop indexes by way of the [out] parameters.

Parameters:

startIndex - [out] The integer reference supplied to this parameter receives the index of the point that starts a subpath.

endIndex - [out] The integer reference supplied to this parameter receives the index of the point that ends the subpath to which startIndex points.

Returns:

The number of points between this marker and the next.

nextMarker

public int nextMarker(GraphicsPath path)

This GraphicsPathIterator object has a GraphicsPath object associated with it. This method increments the associated GraphicsPath to the next marker in its path and copies all the points contained between the current marker and the next marker (or end of path) to a second GraphicsPath object passed in to the parameter.

Parameters:

path - The GraphicsPath object to which the points will be copied.

Returns:

The number of points between this marker and the next.

nextPathType

public int nextPathType(byte[] pathType,
                        int[] startIndex,
                        int[] endIndex)

Gets the starting index and the ending index of the next group of data points that all have the same type.

Parameters:

pathType - [out] Receives the point type shared by all points in the group. Possible types can be retrieved from the PathPointType enumeration.

startIndex - [out] Receives the starting index of the group of points.

endIndex - [out] Receives the ending index of the group of points.

Returns:

This method returns the number of data points in the group. If there are no more groups in the path, this method returns 0.

nextSubpath

public int nextSubpath(int[] startIndex,
                       int[] endIndex,
                       boolean[] isClosed)

Moves the GraphicsPathIterator to the next subpath in the path. The start index and end index of the next subpath are contained in the [out] parameters.

Parameters:

startIndex - [out] Receives the starting index of the next subpath.

endIndex - [out] Receives the ending index of the next subpath.

isClosed - [out] Indicates whether the subpath is closed.

Returns:

The number of data points in the retrieved figure (subpath). If there are no more figures to retrieve, zero is returned.

nextSubpath

public int nextSubpath(GraphicsPath path,
                       boolean[] isClosed)

Gets the next figure (subpath) from the associated path of this GraphicsPathIterator.

Parameters:

path - A GraphicsPath that is to have its data points set to match the data points of the retrieved figure (subpath) for this iterator.

isClosed - [out] Indicates whether the current subpath is closed. It is true if the if the figure is closed, otherwise it is false.

Returns:

The number of data points in the retrieved figure (subpath). If there are no more figures to retrieve, zero is returned.

rewind

public void rewind()

Rewinds this GraphicsPathIterator to the beginning of its associated path.