com.yworks.yfiles.geometry

Class GeneralPath.PathCursor

java.lang.Object

com.yworks.yfiles.geometry.GeneralPath.PathCursor

Enclosing class:

GeneralPath

public static class GeneralPath.PathCursor
extends Object

A class that is used by GeneralPath to iterate over the elements the path is made up of.

See Also:

GeneralPath.createCursor()

Method Summary

Modifier and Type	Method and Description
PathType	getCurrent(double[] coordinates) Places the coordinates for the current type into the given array.
PointD	getCurrentEndPoint() Gets the current end point of the last path element.
PathType	getCurrentEndPoint(double[] coordinates) Places the current end coordinates of the last path element into the array.
double	getCurrentEndPointX() Returns the current x coordinate of the last path element.
double	getCurrentEndPointY() Returns the current y coordinate of the last path element.
int	getIndex() Returns the current position of the cursor.
PathType	getPathType() Returns the type of the path at the position of the cursor.
boolean	moveNext() Advances the cursor to the next position if possible.
boolean	movePrevious() Moves the cursor to the previous position in the path.
void	reset() Reset the cursor to point to the beginning of the path.
boolean	toLast() Resets the cursor to point to the last element in the path.

Methods inherited from class java.lang.Object

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

Method Detail

getCurrent

public final PathType getCurrent(double[] coordinates)

Places the coordinates for the current type into the given array.

The array needs to have a length of at least 6, since PathType.CUBIC_TO needs six coordinates. If the path has been flattened a length of two suffices.

Returns:

The current type of the path element.

See Also:

getCurrentEndPoint(double[])

getCurrentEndPoint

public final PointD getCurrentEndPoint()

Gets the current end point of the last path element.

Returns:

The current end point.

getCurrentEndPoint

public final PathType getCurrentEndPoint(double[] coordinates)

Places the current end coordinates of the last path element into the array.

Parameters:

coordinates - An array with length at least 2.

Returns:

The type of the current element.

getCurrentEndPointX

public final double getCurrentEndPointX()

Returns the current x coordinate of the last path element.

Returns:

The x coordinate or 0 if the element is of type PathType.CLOSE.

getCurrentEndPointY

public final double getCurrentEndPointY()

Returns the current y coordinate of the last path element.

Returns:

The y coordinate or 0 if the element is of type PathType.CLOSE.

getIndex

public final int getIndex()

Returns the current position of the cursor.

Returns:

The Index.

getPathType

public final PathType getPathType()

Returns the type of the path at the position of the cursor.

Returns:

The PathType.

moveNext

public final boolean moveNext()

Advances the cursor to the next position if possible.

Returns:

Whether the cursor has been moved successfully. false if the cursor has been moved beyond the end of the path.

movePrevious

public final boolean movePrevious()

Moves the cursor to the previous position in the path.

Returns:

Whether the move was successful.

reset

public final void reset()

Reset the cursor to point to the beginning of the path.

toLast

public final boolean toLast()

Resets the cursor to point to the last element in the path.

Returns:

Whether the cursor has been moved successfully.