Package de.bsommerfeld.pathetic.api.pathing.result

Interface Path

All Superinterfaces:

Iterable<PathPosition>

All Known Implementing Classes:

PathImpl

public interface Path
extends Iterable<PathPosition>

A Path is a sequence of positions that represents a path through a 3D space. The positions are ordered such that the first position is the start of the path and the last position is the end of the path. The path may contain additional positions between the start and end positions.

See Also:

• Iterable<PathPosition>

Method Summary

Modifier and Type	Method	Description
Collection<PathPosition>	collect()	Returns a new Collection of the Path Positions of the path.
PathPosition	getEnd()	Returns the target position of the path
PathPosition	getStart()	Returns the start position of the path
int	length()	The length of the Path compiled from the number of positions

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Details

length

int length()

The length of the Path compiled from the number of positions

Returns:

the length of the path

getStart

PathPosition getStart()

Returns the start position of the path

Returns:

PathPosition The position of the start

getEnd

PathPosition getEnd()

Returns the target position of the path

Returns:

PathPosition The position of the target

collect

Collection<PathPosition> collect()

Returns a new Collection of the Path Positions of the path.

Returns:

Collection of the PathPositions