Package org.djutils.draw.line

Class PolyLine2d

    • Constructor Detail

      • PolyLine2d

        PolyLine2d​(boolean copyNeeded,
           double[] x,
           double[] y)
    throws NullPointerException,
           DrawRuntimeException
        Construct a new PolyLine2d from an array of double x values and an array of double y values.
        Parameters:
        copyNeeded - boolean; if true; a deep copy of the points array is stored instead of the provided array
        x - double[]; the x-coordinates of the points
        y - double[]; the y-coordinates of the points
        Throws:
        NullPointerException - when iterator is null
        DrawRuntimeException - when the provided points do not constitute a valid line (too few points or identical adjacent points)

      • PolyLine2d

        public PolyLine2d​(double x,
                  double y,
                  double heading)
           throws DrawRuntimeException
        Construct a degenerate PolyLine2d (consisting of only one point).
        Parameters:
        x - double; the x-coordinate
        y - double; the y-coordinate
        heading - double; the heading in radians
        Throws:
        DrawRuntimeException - when x, y, or heading is NaN, or heading is infinite

      • PolyLine2d

        public PolyLine2d​(double[] x,
                  double[] y)
           throws NullPointerException,
                  DrawRuntimeException
        Construct a new PolyLine2d from an array of Point2d. This constructor makes a deep copy of the parameters.
        Parameters:
        x - double[]; the x-coordinates of the points
        y - double[]; the y-coordinates of the points
        Throws:
        NullPointerException - when iterator is null
        DrawRuntimeException - when the provided points do not constitute a valid line (too few points or identical adjacent points)

      • PolyLine2d

        public PolyLine2d​(Point2d point1,
                  Point2d point2,
                  Point2d... otherPoints)
           throws NullPointerException,
                  DrawRuntimeException
        Construct a new PolyLine2d from an array of Point2d.
        Parameters:
        point1 - Point2d; starting point of the PolyLine2d
        point2 - Point2d; second point of the PolyLine2d
        otherPoints - Point2d...; additional points of the PolyLine2d (may be null)
        Throws:
        NullPointerException - when iterator is null
        DrawRuntimeException - when the provided points do not constitute a valid line (too few points or identical adjacent points)

      • PolyLine2d

        public PolyLine2d​(boolean filterDuplicates,
                  Point2d... points)
           throws DrawRuntimeException
        Create a new PolyLine2d, optionally filtering out repeating successive points.
        Parameters:
        filterDuplicates - boolean; if true; filter out successive repeated points; otherwise do not filter
        points - Point2d...; the coordinates of the line as Point2d
        Throws:
        DrawRuntimeException - when number of points < 2

      • PolyLine2d

        public PolyLine2d​(boolean filterDuplicates,
                  List<Point2d> pointList)
           throws DrawRuntimeException
        Create a new PolyLine2d, optionally filtering out repeating successive points.
        Parameters:
        filterDuplicates - boolean; if true; filter out successive repeated points; otherwise do not filter
        pointList - List<Point2d>; list of the coordinates of the line as Point3d; any duplicate points in this list are removed (this method may modify the provided list)
        Throws:
        DrawRuntimeException - when number of non-equal points < 2

    • Method Detail

      • makeArray

        protected static double[] makeArray​(Point2d[] points,
                                    Function<Point2d,​Double> getter)
        Make an array of double an fill it with the appropriate coordinate of points.
        Parameters:
        points - Point2d[]; array of points
        getter - Function<Point2d, Double>; function that obtains the intended coordinate
        Returns:
        double[]; array of double filled with the requested coordinate values

      • iteratorToList

        protected static List<Point2d> iteratorToList​(Iterator<Point2d> iterator)
        Build a list from the Point2d objects that an iterator provides.
        Parameters:
        iterator - Iterator<Point2d>; the iterator that will provide the points
        Returns:
        List<Point2d>; a list of the points provided by the iterator

      • cleanPoints

        static Iterator<Point2d> cleanPoints​(boolean filter,
                                     Iterator<Point2d> iterator)
        Return an iterator that optionally skips identical successive points.
        Parameters:
        filter - boolean; if true; filter out itentical successive points; if false; do not filter
        iterator - Iterator<Point2d>; iterator that generates points, potentially with successive duplicates
        Returns:
        Iterator<Point2d>; iterator that skips identical successive points

      • size

        public int size()
        Retrieve the number of points that make up the object.
        Specified by:
        size in interface Drawable<Point2d>
        Returns:
        int; the number of points that make up the object

      • getSegment

        public LineSegment2d getSegment​(int index)
        Extract one LineSegment of this PolyLine, or Polygon.
        Specified by:
        getSegment in interface PolyLine<PolyLine2d,​Point2d,​Ray2d,​LineSegment2d>
        Parameters:
        index - int; the rank number of the segment; must be in range 0..Size() - 2 for PolyLine, or 0.. Size() - 1 for Polygon.
        Returns:
        LS; the LineSegment that connects point index to point index + 1

      • lengthAtIndex

        public final double lengthAtIndex​(int index)
        Access the internal lengthIndexedLine. Return the cumulative length up to point index of this line
        Specified by:
        lengthAtIndex in interface PolyLine<PolyLine2d,​Point2d,​Ray2d,​LineSegment2d>
        Parameters:
        index - int; the index
        Returns:
        double; the cumulative length of this line up to point index

      • getLength

        public double getLength()
        Return the length of this line. This is NOT the number of points; it is the sum of the lengths of the segments.
        Specified by:
        getLength in interface PolyLine<PolyLine2d,​Point2d,​Ray2d,​LineSegment2d>
        Returns:
        double; the length of this line

      • getPoints

        public Iterator<Point2d> getPoints()
        Retrieve, or generate all points that make up the object.
        Specified by:
        getPoints in interface Drawable<Point2d>
        Returns:
        Iterable<Point2d>; an iterator that generates all points that make up the object

      • getBounds

        public Bounds2d getBounds()
        Retrieve the bounding rectangle of the object.
        Specified by:
        getBounds in interface Drawable2d
        Returns:
        Bounds2d; the bounding box of the object

      • noiseFilteredLine

        public final PolyLine2d noiseFilteredLine​(double noiseLevel)
        Construct a new PolyLine that is equal to this line except for segments that are shorter than the noiseLevel. The result is guaranteed to start with the first point of this line and end with the last point of this line.
        Specified by:
        noiseFilteredLine in interface PolyLine<PolyLine2d,​Point2d,​Ray2d,​LineSegment2d>
        Parameters:
        noiseLevel - double; the minimum segment length that is not removed
        Returns:
        PolyLine2d; the filtered line

      • concatenate

        public static PolyLine2d concatenate​(PolyLine2d... lines)
                              throws DrawRuntimeException
        Concatenate several PolyLine2d instances.
        Parameters:
        lines - PolyLine2d...; One or more PolyLine2d objects. The last point of the first <strong>must</strong> match the first of the second, etc.
        Returns:
        PolyLine2d
        Throws:
        DrawRuntimeException - if zero lines are given, or when there is a gap between consecutive lines

      • concatenate

        public static PolyLine2d concatenate​(double tolerance,
                                     PolyLine2d line1,
                                     PolyLine2d line2)
                              throws DrawRuntimeException
        Concatenate two PolyLine2d instances. This method is separate for efficiency reasons.
        Parameters:
        tolerance - double; the tolerance between the end point of a line and the first point of the next line
        line1 - PolyLine2d; first line
        line2 - PolyLine2d; second line
        Returns:
        PolyLine2d; the concatenation of the two lines
        Throws:
        DrawRuntimeException - if zero lines are given, or when there is a gap between consecutive lines

      • concatenate

        public static PolyLine2d concatenate​(double tolerance,
                                     PolyLine2d... lines)
                              throws DrawRuntimeException
        Concatenate several PolyLine2d instances.
        Parameters:
        tolerance - double; the tolerance between the end point of a line and the first point of the next line
        lines - PolyLine2d...; one or more PolyLine2d objects. The last point of the first <strong>must</strong> match the first of the second, etc.
        Returns:
        PolyLine2d; the concatenation of the lines
        Throws:
        DrawRuntimeException - if zero lines are given, or when there is a gap between consecutive lines

      • getLocationExtended

        public final Ray2d getLocationExtended​(double position)
        Get the location at a position on the line, with its direction. Position can be below 0 or more than the line length. In that case, the position will be extrapolated in the direction of the line at its start or end.
        Specified by:
        getLocationExtended in interface PolyLine<PolyLine2d,​Point2d,​Ray2d,​LineSegment2d>
        Parameters:
        position - double; the position on the line for which to calculate the point on, before, or after the line
        Returns:
        R; a Ray at the position on the line, pointing in the direction of the line at that position. If the position is at (or very near) a point on this PolyLine, the direction is either the direction before, or the direction after that point. If the position is before the start point of this PolyLine, the direction is towards the start point. If the position is beyond the end of this PolyLine, the direction is the direction of the last segment of this PolyLine.

      • getLocation

        public final Ray2d getLocation​(double position)
                        throws DrawRuntimeException
        Get the location at a position on the line, with its direction. Position should be between 0.0 and line length.
        Specified by:
        getLocation in interface PolyLine<PolyLine2d,​Point2d,​Ray2d,​LineSegment2d>
        Parameters:
        position - double; the position on the line for which to calculate the point on the line
        Returns:
        R; a Ray at the position on the line, pointing in the direction of the line at that position. If the position is at (or very near) a point on this PolyLine, the direction is either the direction before, or the direction after that point
        Throws:
        DrawRuntimeException - when position is NaN, less than 0.0, or more than line length.

      • closestPointOnPolyLine

        public Point2d closestPointOnPolyLine​(Point2d point)
        Project a Point on this PolyLine. If the the projected points lies outside this PolyLine, the nearest end point of this PolyLine is returned. Otherwise the returned point lies between the end points of this PolyLine.
        Specified by:
        closestPointOnPolyLine in interface PolyLine<PolyLine2d,​Point2d,​Ray2d,​LineSegment2d>
        Parameters:
        point - P; the point to project onto this PolyLine
        Returns:
        P; either the start point, or the end point of this PolyLine or a Point that lies somewhere along this PolyLine.

      • projectOrthogonal

        public Point2d projectOrthogonal​(Point2d point)
                          throws NullPointerException
        Project a point onto this object. For PolyLines, there may be multiple valid solutions. In that case the solution that lies on the closest segment is returned. If there is no valid solution on the closest segment, null is returned.
        Specified by:
        projectOrthogonal in interface Project<Point2d>
        Parameters:
        point - P; the point
        Returns:
        P; the projection of the point (may be null if no sensible projection is possible). If the result is not null; the result lies somewhere on this object.
        Throws:
        NullPointerException - when point is null;

      • projectOrthogonalExtended

        public Point2d projectOrthogonalExtended​(Point2d point)
                                  throws NullPointerException
        Project a point onto this object. For PolyLines, there may be multiple valid solutions. In that case the solution that lies on the closest segment is returned.
        Specified by:
        projectOrthogonalExtended in interface Project<Point2d>
        Parameters:
        point - P; the point
        Returns:
        P; the projection of the point. This result cannot be null, but it may not lie on this object, but, in stead, lie on a line, or plane that extends this object
        Throws:
        NullPointerException - when point is null;

      • projectOrthogonalFractional

        public final double projectOrthogonalFractional​(Point2d point)
                                         throws NullPointerException
        Project a point onto this object. For PolyLines, there may be multiple valid solutions. In that case the solution that lies on the closest segment is returned. If there is no valid solution on the closest segment, null is returned.
        Specified by:
        projectOrthogonalFractional in interface Project<Point2d>
        Parameters:
        point - P; the point
        Returns:
        double; the fractional position of the projection of the point (may be NaN if no sensible projection is possible). If the result is not null; the result lies somewhere on this object.
        Throws:
        NullPointerException - when point is null;

      • projectOrthogonalFractionalExtended

        public double projectOrthogonalFractionalExtended​(Point2d point)
                                           throws NullPointerException
        Project a point onto this object. For PolyLines, there may be multiple valid solutions. In that case the solution that lies on the closest segment is returned.
        Specified by:
        projectOrthogonalFractionalExtended in interface Project<Point2d>
        Parameters:
        point - P; the point
        Returns:
        double; the fractional position of the projection of the point. This result cannot be NaN, but it may be outside the range 0.0 .. 1.0.
        Throws:
        NullPointerException - when point is null;

      • extract

        public PolyLine2d extract​(double start,
                          double end)
                   throws DrawRuntimeException
        Create a new PolyLine that covers a sub-section of this PolyLine.
        Specified by:
        extract in interface PolyLine<PolyLine2d,​Point2d,​Ray2d,​LineSegment2d>
        Parameters:
        start - double; length along this PolyLine where the sub-section starts, valid range [0..end)
        end - double; length along this PolyLine where the sub-section ends, valid range (start..length (length is the length of this PolyLine)
        Returns:
        L; a new PolyLine covering the selected sub-section
        Throws:
        DrawRuntimeException - when start >= end, or start < 0, or end > length

      • truncate

        public PolyLine2d truncate​(double position)
                    throws DrawRuntimeException
        Truncate this PolyLine at the given length (less than the length of the line, and larger than zero) and return a new line.
        Specified by:
        truncate in interface PolyLine<PolyLine2d,​Point2d,​Ray2d,​LineSegment2d>
        Parameters:
        position - double; the position along the line where to truncate the line
        Returns:
        L; a new PolyLine that follows this PolyLine, but ends at the position where line.getLength() == lengthSI
        Throws:
        DrawRuntimeException - when position less than 0.0 or more than line length.

      • offsetLine

        public PolyLine2d offsetLine​(double offset,
                             double circlePrecision,
                             double offsetMinimumFilterValue,
                             double offsetMaximumFilterValue,
                             double offsetFilterRatio,
                             double minimumOffset)
                      throws IllegalArgumentException
        Construct an offset line. This is similar to what geographical specialists call buffering, except that this method only construct a new line on one side of the reference line and does not add half disks (or miters) around the end points. This method tries to strike a delicate balance between generating too few and too many points to approximate arcs. Noise in this (the reference line) can cause major artifacts in the offset line.
        In the 3D version the offset is parallel to the X-Y plane.
        Specified by:
        offsetLine in interface PolyLine<PolyLine2d,​Point2d,​Ray2d,​LineSegment2d>
        Parameters:
        offset - double; the offset; positive values indicate left of the reference line, negative values indicate right of the reference line
        circlePrecision - double; precision of approximation of arcs; the line segments that are used to approximate an arc will not deviate from the exact arc by more than this value
        offsetMinimumFilterValue - double; noise in the reference line less than this value is always filtered
        offsetMaximumFilterValue - double; noise in the reference line greater than this value is never filtered
        offsetFilterRatio - double; noise in the reference line less than offset / offsetFilterRatio is filtered except when the resulting value exceeds offsetMaximumFilterValue
        minimumOffset - double; an offset value less than this value is treated as 0.0
        Returns:
        L; a PolyLine at the specified offset from the reference line
        Throws:
        IllegalArgumentException - when offset is NaN, or circlePrecision, offsetMinimumFilterValue, offsetMaximumfilterValue, offsetFilterRatio, or minimumOffset is not positive, or NaN, or offsetMinimumFilterValue >= offsetMaximumFilterValue

      • offsetLine

        public PolyLine2d offsetLine​(double offsetAtStart,
                             double offsetAtEnd,
                             double circlePrecision,
                             double offsetMinimumFilterValue,
                             double offsetMaximumFilterValue,
                             double offsetFilterRatio,
                             double minimumOffset)
                      throws IllegalArgumentException,
                             DrawRuntimeException
        Construct an offset line. This is similar to what geographical specialists call buffering, except that this method only construct a new line on one side of the reference line and does not add half disks (or miters) around the end points. This method tries to strike a delicate balance between generating too few and too many points to approximate arcs. Noise in this (the reference line) can cause major artifacts in the offset line.
        In the 3D version the offset is parallel to the X-Y plane.
        Specified by:
        offsetLine in interface PolyLine<PolyLine2d,​Point2d,​Ray2d,​LineSegment2d>
        Parameters:
        offsetAtStart - double; the offset at the start of this line; positive values indicate left of the reference line, negative values indicate right of the reference line
        offsetAtEnd - double; the offset at the end of this line; positive values indicate left of the reference line, negative values indicate right of the reference line
        circlePrecision - double; precision of approximation of arcs; the line segments that are used to approximate an arc will not deviate from the exact arc by more than this value
        offsetMinimumFilterValue - double; noise in the reference line less than this value is always filtered
        offsetMaximumFilterValue - double; noise in the reference line greater than this value is never filtered
        offsetFilterRatio - double; noise in the reference line less than offset / offsetFilterRatio is filtered except when the resulting value exceeds offsetMaximumFilterValue
        minimumOffset - double; an offset value less than this value is treated as 0.0
        Returns:
        L; a PolyLine at the specified offset from the reference line
        Throws:
        IllegalArgumentException - when offset is NaN, or circlePrecision, offsetMinimumFilterValue, offsetMaximumfilterValue, offsetFilterRatio, or minimumOffset is not positive, or NaN, or offsetMinimumFilterValue >= offsetMaximumFilterValue
        DrawRuntimeException - Only if P is PolyLine3d and the line cannot be projected into 2d

      • projectRay

        public double projectRay​(Ray2d ray)
                  throws NullPointerException
        Find a location on this PolyLine2d that is a reasonable projection of a Ray on this line. The result (if not NaN) lies on a line perpendicular to the direction of the Ray and on some segment of this PolyLine. This method attempts to give continuous results for continuous changes of the Ray that must be projected. There are cases where this is simply impossible, or the optimal result is ambiguous. In these cases this method will return something that is hopefully good enough.
        Parameters:
        ray - Ray2d; the Ray
        Returns:
        double; length along this PolyLine (some value between 0 and the length of this PolyLine) where ray projects, or NaN if there is no solution
        Throws:
        NullPointerException - when ray is null

      • toPath2D

        public Path2D toPath2D()
        Construct a Path2D from this PolyLine2d. The result is NOT cached (in the current implementation).
        Returns:
        Path2D; newly construct Path2D consisting solely of straight segments.

      • toString

        public String toString()
        Produce a string describing the Drawable using default conversion for the (double) coordinate values. Regrettably, it is not allowed to provide a default implementation here.
        Specified by:
        toString in interface Drawable<Point2d>
        Overrides:
        toString in class Object
        Returns:
        String; a string describing the Drawable

      • toString

        public String toString​(String doubleFormat,
                       boolean doNotIncludeClassName)
        Produce a String describing the Drawable.
        Specified by:
        toString in interface Drawable<Point2d>
        Parameters:
        doubleFormat - String; a format string (something like "%6.3f") which will be used to render every coordinate value)
        doNotIncludeClassName - boolean; if true; the output of toString is not prefixed by the class name. This is useful for concatenating the textual representation of lots of Drawables (e.g. an array, or a List).
        Returns:
        String; textual representation of the Drawable

      • toPlot

        public String toPlot()
        Convert this PolyLine2D to Peter's plot format.
        Returns:
        Peter's format plot output

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object