org.openimaj.math.geometry.path

Class Polyline

java.lang.Object

org.openimaj.math.geometry.point.PointList

org.openimaj.math.geometry.path.Polyline

All Implemented Interfaces:

Cloneable, Iterable<Point2d>, GeometricObject2d, Path2d

public class Polyline
extends PointList
implements Path2d

A polyline is a Path2d implicitly made up of Line2d segments based on the assumption of ordered points held in a PointList.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Field Summary

Fields inherited from class org.openimaj.math.geometry.point.PointList

points

Constructor Summary

Constructors

Constructor and Description
Polyline(Iterator<Line2d> lineIterator) Construct a Polyline from line segments
Polyline(List<? extends Point2d> points) Construct a Polyline from points
Polyline(List<? extends Point2d> points, boolean copy) Construct a Polyline from the points, possibly copying the points first
Polyline(Point2d... points) Construct a Polyline from points

Method Summary

Modifier and Type	Method and Description
Polyline	asPolyline() Convert the path to a polyline representation
Point2d	begin() Get the beginning of the path
double	calculateLength() Calculate the length of the path
Point2d	end() Get the end of the path
Iterator<Line2d>	lineIterator() Convert the path to a iterated polyline representation

Methods inherited from class org.openimaj.math.geometry.point.PointList

calculateCentroid, calculateConvexHull, calculateRegularBoundingBox, clone, computeIntrinsicScale, computeMean, get, getHeight, getLines, getLines, getWidth, iterator, maxX, maxY, minX, minY, rotate, rotate, scale, scale, scaleCentroid, scaleX, scaleXY, scaleY, size, toString, transform, translate

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openimaj.math.geometry.GeometricObject2d

calculateCentroid, calculateRegularBoundingBox, getHeight, getWidth, maxX, maxY, minX, minY, scale, scale, scaleCentroid, transform, translate

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Polyline

public Polyline(Point2d... points)

Construct a Polyline from points

Parameters:

points - the points

Polyline

public Polyline(List<? extends Point2d> points)

Construct a Polyline from points

Parameters:

points - the points

Polyline

public Polyline(List<? extends Point2d> points,
                boolean copy)

Construct a Polyline from the points, possibly copying the points first

Parameters:

points - the points

copy - should the points be copied

Polyline

public Polyline(Iterator<Line2d> lineIterator)

Construct a Polyline from line segments

Parameters:

lineIterator - a line segment iterator

Method Detail

begin

public Point2d begin()

Description copied from interface: Path2d

Get the beginning of the path

Specified by:

begin in interface Path2d

Returns:

the beginning

end

public Point2d end()

Description copied from interface: Path2d

Get the end of the path

Specified by:

end in interface Path2d

Returns:

the end

asPolyline

public Polyline asPolyline()

Description copied from interface: Path2d

Convert the path to a polyline representation

Specified by:

asPolyline in interface Path2d

Returns:

a polyline representation of the path

lineIterator

public Iterator<Line2d> lineIterator()

Description copied from interface: Path2d

Convert the path to a iterated polyline representation

Specified by:

lineIterator in interface Path2d

Returns:

an iterated polyline representation of the path

calculateLength

public double calculateLength()

Description copied from interface: Path2d

Calculate the length of the path

Specified by:

calculateLength in interface Path2d

Returns:

the path length