C

GeneralPathCursor

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

Remarks

This class cannot be instantiated

See Also

API

createCursor

Members

No filters for this type

Properties

currentEndPoint

: Point
readonly
Gets the current end point of the last path element.
readonlyfinal

Property Value

The current end point.

currentEndPointX

: number
readonly
Gets the current x coordinate of the last path element.
readonlyfinal

Property Value

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

currentEndPointY

: number
readonly
Gets the current y coordinate of the last path element.
readonlyfinal

Property Value

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

index

: number
readonly
Gets the current position of the cursor.
readonlyfinal

pathType

: PathType
readonly
Gets the type of the path at the position of the cursor.
readonlyfinal

Methods

getCurrent

(coordinates: number[]): PathType
Places the coordinates for the current type into the given array.
final

Parameters

coordinates: number[]
The coordinates. 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.

Return Value

PathType
The current type of the path element.

See Also

API
getCurrentEndPoint

getCurrentEndPoint

(coordinates: number[]): PathType
Places the current end coordinates of the last path element into the array.
final

Parameters

coordinates: number[]
An array with a length of at least 2.

Return Value

PathType
The type of the current element.

moveNext

(): boolean
Advances the cursor to the next position if possible.
final

Return Value

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

movePrevious

(): boolean
Moves the cursor to the previous position in the path.
final

Return Value

boolean
Whether the move was successful.

reset

()
Reset the cursor to point to the beginning of the path.
final

toLast

(): boolean
Resets the cursor to point to the last element in the path.
final

Return Value

boolean
Whether the cursor has been moved successfully.