math.geom2d.line
Class Polyline2D

java.lang.Object
  math.geom2d.line.Polyline2D

All Implemented Interfaces:

java.awt.Shape, ContinuousCurve2D, ContinuousOrientedCurve2D, Curve2D, OrientedCurve2D, Shape2D

Direct Known Subclasses:

ClosedPolyline2D

public class Polyline2D
extends java.lang.Object
implements ContinuousOrientedCurve2D

A polyline is a continuous curve where each piece of the curve is a LineSegment2D.

Author:

dlegland

Field Summary

protected java.util.ArrayList<Point2D>

points

Fields inherited from interface math.geom2d.curve.ContinuousCurve2D

CIRCLE, CLOSED_EDGE, LOOP, OPEN_EDGE

Fields inherited from interface math.geom2d.Shape2D

ACCURACY, defaultClipWindow, EMPTY_SET

Constructor Summary

Polyline2D()

Polyline2D(java.util.Collection<? extends Point2D> points)

Polyline2D(double[] xcoords, double[] ycoords)

Polyline2D(Point2D initialPoint)

Polyline2D(Point2D[] points)

Method Summary

void	addPoint(Point2D point)
java.awt.geom.GeneralPath	appendPath(java.awt.geom.GeneralPath path) Append the path of the curve to the given path.
void	clearPoints()
CurveSet2D<? extends Polyline2D>	clip(Box2D box) Clip the polyline by a box.
boolean	contains(double x, double y)
boolean	contains(double xr, double yr, double wr, double hr) Return false, as a curve can not contain a Rectangle
boolean	contains(java.awt.geom.Point2D point)
boolean	contains(java.awt.geom.Rectangle2D rect) Return false, as a curve can not contain a Rectangle
boolean	equals(java.lang.Object object)
Polyline2D	getAsPolyline(int n) Returns an approximation of the curve as a polyline with n line segments.
Box2D	getBoundingBox() Returns the bounding box of the shape.
java.awt.Rectangle	getBounds()
java.awt.geom.Rectangle2D	getBounds2D()
java.util.Collection<ContinuousCurve2D>	getContinuousCurves() Returns the collection of continuous curves which constitute this curve.
double	getDistance(double x, double y) get the distance of the shape to the given point, specified by x and y, or the distance of point to the frontier of the shape in the case of a plain (i.e. fillable) shape.
double	getDistance(java.awt.geom.Point2D point) get the distance of the shape to the given point, or the distance of point to the frontier of the shape in the case of a plain shape.
java.util.Collection<LineSegment2D>	getEdges() return an array of LineSegment2D.
Point2D	getFirstPoint() Get the first point of the curve.
java.awt.geom.GeneralPath	getGeneralPath() Return a general path iterator.
java.util.Collection<Point2D>	getIntersections(StraightObject2D line) Returns the intersection points of the curve with the specified line.
Point2D	getLastPoint() if polyline is closed, return the first point.
java.awt.geom.PathIterator	getPathIterator(java.awt.geom.AffineTransform trans) Return pathiterator for this polyline.
java.awt.geom.PathIterator	getPathIterator(java.awt.geom.AffineTransform trans, double flatness) Return pathiterator for this polyline.
Point2D	getPoint(double t) Gets the point from a parametric representation of the curve.
Point2D	getPoint(double t, Point2D point) Same as getPoint(t), but gives the point as a parameter.
Point2D[]	getPointArray() Return the collection of points as an array of Point2D.
java.util.Collection<Point2D>	getPoints() Return the inner collection of points.
java.util.Iterator<Point2D>	getPointsIterator() Return an iterator on the collection of points.
double	getPosition(Point2D point) Get position of the point on the curve.
Polyline2D	getReverseCurve() Returns the polyline with same points considered in reverse order.
double	getSignedDistance(double x, double y) The same as getSignedDistance(Point2D), but by passing 2 double as arguments.
double	getSignedDistance(java.awt.geom.Point2D point) Get the signed distance of the curve to the given point : this distance is positive if the point lies outside the shape, and is negative if the point lies inside the shape.
java.util.Collection<? extends SmoothCurve2D>	getSmoothPieces() Returns a set of smooth curves.
Polyline2D	getSubCurve(double t0, double t1) Return an instance of Polyline2D.
double	getT0() returns 0.
double	getT1() return the number of points in the polyline, minus one.
int	getVerticesNumber()
double	getWindingAngle(java.awt.geom.Point2D point) Return the angle portion that the curve turn around the given point.
boolean	intersects(double xr, double yr, double wr, double hr)
boolean	intersects(java.awt.geom.Rectangle2D rect)
boolean	isBounded() Always returns true, because a polyline is always bounded.
boolean	isClosed() return false, as Polyline2D is not closed by definition.
boolean	isInside(java.awt.geom.Point2D pt) return true if the point is 'inside' the domain bounded by the curve.
double	project(Point2D point) Returns the position of the closest orthogonal projection of the point on the curve, or of the closest singular point.
void	removePoint(Point2D point)
Polyline2D	transform(AffineTransform2D trans) Transforms the curve by an affine transform.

Methods inherited from class java.lang.Object

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

Field Detail

points

protected java.util.ArrayList<Point2D> points

Constructor Detail

Polyline2D

public Polyline2D()

Polyline2D

public Polyline2D(Point2D initialPoint)

Polyline2D

public Polyline2D(Point2D[] points)

Polyline2D

public Polyline2D(java.util.Collection<? extends Point2D> points)

Polyline2D

public Polyline2D(double[] xcoords,
                  double[] ycoords)

Method Detail

getPointsIterator

public java.util.Iterator<Point2D> getPointsIterator()

Return an iterator on the collection of points.

getPointArray

public Point2D[] getPointArray()

Return the collection of points as an array of Point2D.

Returns:

an array of Point2D

addPoint

public void addPoint(Point2D point)

removePoint

public void removePoint(Point2D point)

clearPoints

public void clearPoints()

getPoints

public java.util.Collection<Point2D> getPoints()

Return the inner collection of points.

getVerticesNumber

public int getVerticesNumber()

getEdges

public java.util.Collection<LineSegment2D> getEdges()

return an array of LineSegment2D. The number of edges is the number of vertices minus one.

Returns:

the edges of the polyline

getAsPolyline

public Polyline2D getAsPolyline(int n)

Description copied from interface: ContinuousCurve2D

Returns an approximation of the curve as a polyline with n line segments. If the curve is closed, the method should return an instance of ClosedPolyline2D.

Specified by:

getAsPolyline in interface ContinuousCurve2D

Parameters:

n - the number of line segments

Returns:

a closed polyline with n line segments.

getSignedDistance

public double getSignedDistance(double x,
                                double y)

Description copied from interface: OrientedCurve2D

The same as getSignedDistance(Point2D), but by passing 2 double as arguments.

Specified by:

getSignedDistance in interface OrientedCurve2D

Parameters:

x - x-coord of a point

y - y-coord of a point

Returns:

the signed distance of the point (x,y) to the curve

getSignedDistance

public double getSignedDistance(java.awt.geom.Point2D point)

Description copied from interface: OrientedCurve2D

Get the signed distance of the curve to the given point : this distance is positive if the point lies outside the shape, and is negative if the point lies inside the shape. In this case, absolute value of distance is equals to the distance to the border of the shape.

Specified by:

getSignedDistance in interface OrientedCurve2D

Parameters:

point - a point of the plane

Returns:

the signed distance to the curve

getWindingAngle

public double getWindingAngle(java.awt.geom.Point2D point)

Description copied from interface: OrientedCurve2D

Return the angle portion that the curve turn around the given point. Result is a signed angle.

Specified by:

getWindingAngle in interface OrientedCurve2D

Parameters:

point - a point of the plane

Returns:

a signed angle

isInside

public boolean isInside(java.awt.geom.Point2D pt)

Description copied from interface: OrientedCurve2D

return true if the point is 'inside' the domain bounded by the curve.

Specified by:

isInside in interface OrientedCurve2D

Parameters:

pt - a point in the plane

Returns:

true if the point is on the left side of the curve.

isClosed

public boolean isClosed()

return false, as Polyline2D is not closed by definition.

Specified by:

isClosed in interface ContinuousCurve2D

getSmoothPieces

public java.util.Collection<? extends SmoothCurve2D> getSmoothPieces()

Description copied from interface: ContinuousCurve2D

Returns a set of smooth curves.

Specified by:

getSmoothPieces in interface ContinuousCurve2D

getIntersections

public java.util.Collection<Point2D> getIntersections(StraightObject2D line)

Description copied from interface: Curve2D

Returns the intersection points of the curve with the specified line. The length of the result array is the number of intersection points.

Specified by:

getIntersections in interface Curve2D

getPoint

public Point2D getPoint(double t,
                        Point2D point)

Description copied from interface: Curve2D

Same as getPoint(t), but gives the point as a parameter. This avoids repetitive memory allocations.

Specified by:

getPoint in interface Curve2D

getPoint

public Point2D getPoint(double t)

Description copied from interface: Curve2D

Gets the point from a parametric representation of the curve. If the parameter lies outside the definition range, the parameter corresponding to the closest bound is used instead. This method can be used to draw an approximated outline of a curve, by selecting multiple values for t and drawing lines between them.

Specified by:

getPoint in interface Curve2D

getPosition

public double getPosition(Point2D point)

Description copied from interface: Curve2D

Get position of the point on the curve. If the point does not belong to the curve, return Double.NaN.

Specified by:

getPosition in interface Curve2D

Parameters:

point - a point belonging to the curve

Returns:

the position of the point on the curve

project

public double project(Point2D point)

Description copied from interface: Curve2D

Returns the position of the closest orthogonal projection of the point on the curve, or of the closest singular point. This function should always returns a valid value.

Specified by:

project in interface Curve2D

Parameters:

point - a point to project

Returns:

the position of the closest orthogonal projection

getT0

public double getT0()

returns 0.

Specified by:

getT0 in interface Curve2D

getT1

public double getT1()

return the number of points in the polyline, minus one.

Specified by:

getT1 in interface Curve2D

getFirstPoint

public Point2D getFirstPoint()

Description copied from interface: Curve2D

Get the first point of the curve. It must returns the same result as getPoint(getT0()).

Specified by:

getFirstPoint in interface Curve2D

Returns:

the first point of the curve

getLastPoint

public Point2D getLastPoint()

if polyline is closed, return the first point.

Specified by:

getLastPoint in interface Curve2D

Returns:

the last point of the curve.

isBounded

public boolean isBounded()

Always returns true, because a polyline is always bounded.

Specified by:

isBounded in interface Shape2D

getReverseCurve

public Polyline2D getReverseCurve()

Returns the polyline with same points considered in reverse order. Reversed polyline keep same references as original polyline.

Specified by:

getReverseCurve in interface ContinuousCurve2D

Specified by:

getReverseCurve in interface ContinuousOrientedCurve2D

Specified by:

getReverseCurve in interface Curve2D

Specified by:

getReverseCurve in interface OrientedCurve2D

getContinuousCurves

public java.util.Collection<ContinuousCurve2D> getContinuousCurves()

Description copied from interface: Curve2D

Returns the collection of continuous curves which constitute this curve.

Specified by:

getContinuousCurves in interface Curve2D

Returns:

a collection of continuous curves.

getSubCurve

public Polyline2D getSubCurve(double t0,
                              double t1)

Return an instance of Polyline2D. If t1 is lower than t0, return an instance of Polyline2D with zero points.

Specified by:

getSubCurve in interface ContinuousCurve2D

Specified by:

getSubCurve in interface ContinuousOrientedCurve2D

Specified by:

getSubCurve in interface Curve2D

Parameters:

t0 - position of the start of the sub-curve

t1 - position of the end of the sub-curve

Returns:

the portion of original curve comprised between t0 and t1.

clip

public CurveSet2D<? extends Polyline2D> clip(Box2D box)

Clip the polyline by a box. The result is an instance of CurveSet2D, which contains only instances of Polyline2D. If the ellipse arc is not clipped, the result is an instance of CurveSet2D which contains 0 curves.

Specified by:

clip in interface ContinuousCurve2D

Specified by:

clip in interface ContinuousOrientedCurve2D

Specified by:

clip in interface Curve2D

Specified by:

clip in interface OrientedCurve2D

Specified by:

clip in interface Shape2D

Parameters:

box - the clipping box

Returns:

the clipped shape

getBoundingBox

public Box2D getBoundingBox()

Description copied from interface: Shape2D

Returns the bounding box of the shape.

Specified by:

getBoundingBox in interface Shape2D

Returns:

the bounding box of the shape.

getDistance

public double getDistance(double x,
                          double y)

Description copied from interface: Shape2D

get the distance of the shape to the given point, specified by x and y, or the distance of point to the frontier of the shape in the case of a plain (i.e. fillable) shape.

Specified by:

getDistance in interface Shape2D

getDistance

public double getDistance(java.awt.geom.Point2D point)

Description copied from interface: Shape2D

get the distance of the shape to the given point, or the distance of point to the frontier of the shape in the case of a plain shape.

Specified by:

getDistance in interface Shape2D

transform

public Polyline2D transform(AffineTransform2D trans)

Description copied from interface: Curve2D

Transforms the curve by an affine transform. The result is an instance of Curve2D.

Specified by:

transform in interface ContinuousCurve2D

Specified by:

transform in interface ContinuousOrientedCurve2D

Specified by:

transform in interface Curve2D

Specified by:

transform in interface OrientedCurve2D

Specified by:

transform in interface Shape2D

Parameters:

trans - an affine transform

Returns:

the transformed shape

contains

public boolean contains(double x,
                        double y)

Specified by:

contains in interface java.awt.Shape

contains

public boolean contains(java.awt.geom.Point2D point)

Specified by:

contains in interface java.awt.Shape

contains

public boolean contains(double xr,
                        double yr,
                        double wr,
                        double hr)

Return false, as a curve can not contain a Rectangle

Specified by:

contains in interface java.awt.Shape

contains

public boolean contains(java.awt.geom.Rectangle2D rect)

Return false, as a curve can not contain a Rectangle

Specified by:

contains in interface java.awt.Shape

getBounds

public java.awt.Rectangle getBounds()

Specified by:

getBounds in interface java.awt.Shape

getBounds2D

public java.awt.geom.Rectangle2D getBounds2D()

Specified by:

getBounds2D in interface java.awt.Shape

intersects

public boolean intersects(double xr,
                          double yr,
                          double wr,
                          double hr)

Specified by:

intersects in interface java.awt.Shape

intersects

public boolean intersects(java.awt.geom.Rectangle2D rect)

Specified by:

intersects in interface java.awt.Shape

appendPath

public java.awt.geom.GeneralPath appendPath(java.awt.geom.GeneralPath path)

Description copied from interface: ContinuousCurve2D

Append the path of the curve to the given path.

Specified by:

appendPath in interface ContinuousCurve2D

Parameters:

path - a path to modify

Returns:

the modified path

getGeneralPath

public java.awt.geom.GeneralPath getGeneralPath()

Return a general path iterator.

getPathIterator

public java.awt.geom.PathIterator getPathIterator(java.awt.geom.AffineTransform trans)

Return pathiterator for this polyline.

Specified by:

getPathIterator in interface java.awt.Shape

getPathIterator

public java.awt.geom.PathIterator getPathIterator(java.awt.geom.AffineTransform trans,
                                                  double flatness)

Return pathiterator for this polyline.

Specified by:

getPathIterator in interface java.awt.Shape

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object