com.yworks.yfiles.algorithms

Class YPointPath

java.lang.Object

com.yworks.yfiles.algorithms.YPointPath

public final class YPointPath
extends Object

This class represents an ordered list of points in the plane.

Field Summary

Fields

Modifier and Type	Field and Description
static YPointPath	EMPTY_PATH Defines a path with no points.

Constructor Summary

Constructors

Constructor and Description
YPointPath() Creates a new empty path.
YPointPath(List<Object> l) Creates a new path from a list of points.
YPointPath(YPoint[] path) Creates a new path from an array of points.

Method Summary

Modifier and Type	Method and Description
double	calculateLength() Calculate the (geometric) length of the path.
YPointPath	createReverse() Create a point path with reverse ordering of the points.
ICursor	cursor() Get the points in the path.
YPoint	getFirst() Gets the first point in the path.
YPoint	getLast() Gets the last point in the path.
LineSegment	getLineSegment(int i) Returns a line segment in the path.
int	getLineSegmentCount() Gets the number of line segments in the path.
int	length() Get the number of points in the path.
ILineSegmentCursor	lineSegments() Get the points in the path.
IPointCursor	points() Get the points in the path.
YPoint[]	toArray() Get the points in the list as array.
List<Object>	toList() Get the points in the path as list.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_PATH

public static final YPointPath EMPTY_PATH

Defines a path with no points.

Constructor Detail

YPointPath

public YPointPath()

Creates a new empty path.

YPointPath

public YPointPath(List<Object> l)

Creates a new path from a list of points.

Parameters:

l - a list of YPoint instances.

YPointPath

public YPointPath(YPoint[] path)

Creates a new path from an array of points.

Method Detail

calculateLength

public final double calculateLength()

Calculate the (geometric) length of the path.

The length of the path is the sum of lengths of all line segments making up the path.

Returns:

the (geometric) length of the path

createReverse

public final YPointPath createReverse()

Create a point path with reverse ordering of the points.

cursor

public final ICursor cursor()

Get the points in the path.

getFirst

public final YPoint getFirst()

Gets the first point in the path.

Returns:

The First.

getLast

public final YPoint getLast()

Gets the last point in the path.

Returns:

The Last.

getLineSegment

public final LineSegment getLineSegment(int i)

Returns a line segment in the path.

getLineSegmentCount

public final int getLineSegmentCount()

Gets the number of line segments in the path.

Returns:

The LineSegmentCount.

length

public final int length()

Get the number of points in the path.

lineSegments

public final ILineSegmentCursor lineSegments()

Get the points in the path.

points

public final IPointCursor points()

Get the points in the path.

toArray

public final YPoint[] toArray()

Get the points in the list as array.

toList

public final List<Object> toList()

Get the points in the path as list.

Returns:

a list of YPoint instances.

toString

public String toString()

Overrides:

toString in class Object