Package org.eclipse.gef.geometry.planar

Class Polyline

java.lang.Object
org.eclipse.gef.geometry.planar.Polyline
All Implemented Interfaces:
Serializable, Cloneable, ICurve, IGeometry, IRotatable<Polyline>, IScalable<Polyline>, ITranslatable<Polyline>
public class Polyline extends Object implements ICurve
Represents the geometric shape of a polyline. Note that while all manipulations (e.g. within shrink, expand) within this class are based on double precision, all comparisons (e.g. within contains, intersects, equals, etc.) are based on a limited precision (with an accuracy defined within PrecisionUtils) to compensate for rounding effects.
See Also:

  • Constructor Details

    • Polyline

      public Polyline(double... coordinates)
      Constructs a new Polyline from a even-numbered sequence of coordinates. Similar to Polyline(Point...), only that coordinates of points rather than Points are provided.
      Parameters:
      coordinates - an alternating, even-numbered sequence of x- and y-coordinates, representing the points from which the Polyline is to be created

    • Polyline

      public Polyline(Line[] segmentsArray)
      Constructs a new Polyline from the given array of Line segments.
      Parameters:
      segmentsArray - The array of Lines from which this Polyline is constructed.

    • Polyline

      public Polyline(Point... points)
      Constructs a new Polyline from the given sequence of Point s. The Polyline that is created will be automatically closed, i.e. it will not only contain a segment between succeeding points of the sequence but as well back from the last to the first point.
      Parameters:
      points - a sequence of points, from which the Polyline is to be created

  • Method Details

    • contains

      public boolean contains(double x, double y)
      Checks whether the point that is represented by its x- and y-coordinates is contained within this Polyline.
      Parameters:
      x - the x coordinate of the point to test
      y - the y coordinate of the point to test
      Returns:
      true if the point represented by its coordinates if contained within this Polyline, otherwise false

    • contains

      public boolean contains(Point p)
      Description copied from interface: IGeometry
      Returns whether the given Point is contained within this IGeometry. This includes the case that the Point lies on the border of this IGeometry.
      Specified by:
      contains in interface IGeometry
      Parameters:
      p - The Point being tested for containment
      Returns:
      true if the Point is contained within this IGeometry, false otherwise.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • equals

      public boolean equals(Point... points)
      Checks whether this Polyline and the one that is indirectly given via the sequence of points are regarded to be equal. The Polyline s will be regarded equal, if they are characterized by the same segments.
      Parameters:
      points - an array of Point characterizing a Polyline to be checked for equality
      Returns:
      true if the sequence of points that characterize this Polyline and the Polyline indirectly given via the array of points are regarded to form the same segments

    • getCopy

      public Polyline getCopy()
      Description copied from interface: IGeometry
      Returns a new identical copy of this IGeometry.
      Specified by:
      getCopy in interface IGeometry
      Returns:
      a copy identical to this IGeometry

    • getCurves

      public Line[] getCurves()
      Returns a sequence of Lines, representing the segments that are obtained by linking each two successive point of this Polyline (including the last and the first one).
      Returns:
      an array of Lines, representing the segments that make up this Polyline

    • getIntersections

      public Point[] getIntersections(ICurve c)
      Description copied from interface: ICurve
      Returns the points of intersection between this ICurve and the given ICurve.
      Specified by:
      getIntersections in interface ICurve
      Parameters:
      c - The ICurve to compute intersection points with.
      Returns:
      The points of intersection.

    • getLength

      public double getLength()
      Returns the length of this Polyline by adding up the lengths of the individual Lines.
      Returns:
      The length of this Polyline.

    • getOverlaps

      public ICurve[] getOverlaps(ICurve c)
      Description copied from interface: ICurve
      Returns the curve segments at which this ICurve and the given ICurve overlap.
      Specified by:
      getOverlaps in interface ICurve
      Parameters:
      c - The curve to compute overlaps with.
      Returns:
      The segments where both curves overlap.

    • getP1

      public Point getP1()
      Description copied from interface: ICurve
      Returns a Point representing the start point of this ICurve.
      Specified by:
      getP1 in interface ICurve
      Returns:
      a new Point with the coordinates of the ICurve's start point.

    • getP2

      public Point getP2()
      Description copied from interface: ICurve
      Returns a Point representing the end point of this ICurve .
      Specified by:
      getP2 in interface ICurve
      Returns:
      a new Point with the coordinates of the ICurve's end point.

    • getProjection

      public Point getProjection(Point reference)
      Description copied from interface: ICurve
      Returns a projection of the given reference Point onto this ICurve, i.e. a Point on this ICurve that is closest to the given reference Point. Note, that
      Specified by:
      getProjection in interface ICurve
      Parameters:
      reference - The reference Point for which to return the projection.
      Returns:
      The projection of the given reference Point onto this ICurve.

    • getTransformed

      public Polyline getTransformed(AffineTransform t)
      Default implementation returning a transformed Path representation of this IGeometry. Subclasses may override this method to return a more specific representation.
      Specified by:
      getTransformed in interface IGeometry
      Parameters:
      t - The AffineTransform to be applied
      Returns:
      a transformed Path representation of this IGeometry

    • getX1

      public double getX1()
      Description copied from interface: ICurve
      Returns the start Point's x coordinate.
      Specified by:
      getX1 in interface ICurve
      Returns:
      the start Point's x coordinate

    • getX2

      public double getX2()
      Description copied from interface: ICurve
      Returns the end Point's x coordinate.
      Specified by:
      getX2 in interface ICurve
      Returns:
      the end Point's x coordinate

    • getY1

      public double getY1()
      Description copied from interface: ICurve
      Returns the start Point's y coordinate.
      Specified by:
      getY1 in interface ICurve
      Returns:
      the start Point's y coordinate

    • getY2

      public double getY2()
      Description copied from interface: ICurve
      Returns the end Point's y coordinate.
      Specified by:
      getY2 in interface ICurve
      Returns:
      the end Point's y coordinate

    • intersects

      public boolean intersects(ICurve c)
      Description copied from interface: ICurve
      Tests if this ICurve and the given ICurve intersect, i.e. whether a final set of intersection points exists. Two curves intersect if they touch (see IGeometry.touches(IGeometry)) but do not overlap (see ICurve.overlaps(ICurve)).
      Specified by:
      intersects in interface ICurve
      Parameters:
      c - The ICurve to test for intersections.
      Returns:
      true if they intersect, false otherwise

    • overlaps

      public boolean overlaps(ICurve c)
      Description copied from interface: ICurve
      Tests if this ICurve and the given ICurve overlap, i.e. whether an infinite set of intersection points exists. Two curves overlap if they touch (see IGeometry.touches(IGeometry)) but not intersect (see ICurve.intersects(ICurve)).
      Specified by:
      overlaps in interface ICurve
      Parameters:
      c - The ICurve to test for overlap.
      Returns:
      true if they overlap, false otherwise

    • toBezier

      public Line[] toBezier()
      Description copied from interface: ICurve
      Computes a list of BezierCurves that approximate the ICurve. For example, a Line or a BezierCurve in general could return a list with the curve itself as its only element. But an Ellipse or an Arc may return a list of consecutive BezierCurves which approximate the ICurve.
      Specified by:
      toBezier in interface ICurve
      Returns:
      a list of BezierCurves that approximate the ICurve

    • toPath

      public Path toPath()
      Description copied from interface: IGeometry
      Converts this IGeometry into a Path representation.
      Specified by:
      toPath in interface IGeometry
      Returns:
      A new Path representation for this IGeometry.

    • toPolyBezier

      public PolyBezier toPolyBezier()
      Transforms this Polyline into a PolyBezier.
      Returns:
      a PolyBezier representing this Polyline

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getBounds

      public final Rectangle getBounds()
      Description copied from interface: IGeometry
      Returns the smallest Rectangle fully enclosing this IGeometry.
      Specified by:
      getBounds in interface IGeometry
      Returns:
      A new Rectangle object that fully encloses this IGeometry

    • getCentroid

      public Point getCentroid()
      Computes the centroid of this AbstractPointListBasedGeometry. The centroid is the "center of gravity", i.e. assuming a Polygon is spanned by the Points of this AbstractPointListBasedGeometry and it is made of a material of constant density, then it is in a balanced state, if you put it on a pin that is placed exactly on its centroid.
      Returns:
      the center Point (or centroid) of this AbstractPointListBasedGeometry

    • getCoordinates

      public final double[] getCoordinates()
      Returns a double array which represents the sequence of coordinates of the Points that make up this AbstractPointListBasedGeometry.
      Returns:
      an array that alternately contains the x and y coordinates of this AbstractPointListBasedGeometry's points

    • getPoints

      public final Point[] getPoints()
      Returns a copy of the Points that make up this AbstractPointListBasedGeometry.
      Returns:
      an array of Points representing the Points that make up this AbstractPointListBasedGeometry

    • getRotatedCCW

      public Polyline getRotatedCCW(Angle alpha)
      Description copied from interface: IRotatable
      Rotates the calling object by specified Angle counter-clock-wise (CCW) around its center Point. Does not necessarily return an object of the same type.
      Specified by:
      getRotatedCCW in interface IRotatable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
      Parameters:
      alpha - rotation Angle
      Returns:
      an IGeometry representing the result of the rotation

    • getRotatedCCW

      public Polyline getRotatedCCW(Angle angle, double cx, double cy)
      Description copied from interface: IRotatable
      Rotates the calling object by the specified Angle counter-clock-wise (CCW) around the specified center Point (cx, cy). Does not necessarily return an object of the same type.
      Specified by:
      getRotatedCCW in interface IRotatable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
      Parameters:
      angle - rotation Angle
      cx - x-coordinate of the relative Point for the rotation
      cy - y-coordinate of the relative Point for the rotation
      Returns:
      an IGeometry representing the result of the rotation

    • getRotatedCCW

      public Polyline getRotatedCCW(Angle alpha, Point center)
      Description copied from interface: IRotatable
      Rotates the calling object by the specified Angle counter-clock-wise (CCW) around the specified center Point. Does not necessarily return an object of the same type.
      Specified by:
      getRotatedCCW in interface IRotatable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
      Parameters:
      alpha - rotation Angle
      center - relative Point for the rotation
      Returns:
      an IGeometry representing the result of the rotation

    • getRotatedCW

      public Polyline getRotatedCW(Angle alpha)
      Description copied from interface: IRotatable
      Rotates the calling object by specified Angle clock-wise (CW) around its center Point. Does not necessarily return an object of the same type.
      Specified by:
      getRotatedCW in interface IRotatable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
      Parameters:
      alpha - rotation Angle
      Returns:
      an IGeometry representing the result of the rotation

    • getRotatedCW

      public Polyline getRotatedCW(Angle angle, double cx, double cy)
      Description copied from interface: IRotatable
      Rotates the calling object by the specified Angle clock-wise (CW) around the specified center Point (cx, cy). Does not necessarily return an object of the same type.
      Specified by:
      getRotatedCW in interface IRotatable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
      Parameters:
      angle - rotation Angle
      cx - x-coordinate of the relative Point for the rotation
      cy - y-coordinate of the relative Point for the rotation
      Returns:
      an IGeometry representing the result of the rotation

    • getRotatedCW

      public Polyline getRotatedCW(Angle alpha, Point center)
      Description copied from interface: IRotatable
      Rotates the calling object by the specified Angle clock-wise (CW) around the specified center Point. Does not necessarily return an object of the same type.
      Specified by:
      getRotatedCW in interface IRotatable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
      Parameters:
      alpha - rotation Angle
      center - relative Point for the rotation
      Returns:
      an IGeometry representing the result of the rotation

    • getScaled

      public Polyline getScaled(double factor)
      Description copied from interface: IScalable
      Scales a copy of the calling object by the given factor relative to its center Point.
      Specified by:
      getScaled in interface IScalable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
      Parameters:
      factor - scale-factor
      Returns:
      the new, scaled object

    • getScaled

      public Polyline getScaled(double factorX, double factorY)
      Description copied from interface: IScalable
      Scales a copy of the calling object by the given factors relative to its center Point.
      Specified by:
      getScaled in interface IScalable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
      Parameters:
      factorX - x-scale-factor
      factorY - y-scale-factor
      Returns:
      the new, scaled object

    • getScaled

      public Polyline getScaled(double factor, double cx, double cy)
      Description copied from interface: IScalable
      Scales a copy of the calling object by the given factor relative to the given center Point (cx, cy).
      Specified by:
      getScaled in interface IScalable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
      Parameters:
      factor - scale-factor
      cx - x-coordinate of the relative Point for the scaling
      cy - y-coordinate of the relative Point for the scaling
      Returns:
      the new, scaled object

    • getScaled

      public Polyline getScaled(double fx, double fy, double cx, double cy)
      Description copied from interface: IScalable
      Scales a copy of the calling object by the given factors relative to the given center Point (cx, cy).
      Specified by:
      getScaled in interface IScalable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
      Parameters:
      fx - x-scale-factor
      fy - y-scale-factor
      cx - x-coordinate of the relative Point for the scaling
      cy - y-coordinate of the relative Point for the scaling
      Returns:
      the new, scaled object

    • getScaled

      public Polyline getScaled(double factorX, double factorY, Point center)
      Description copied from interface: IScalable
      Scales a copy of the calling object by the given factors relative to the given center Point.
      Specified by:
      getScaled in interface IScalable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
      Parameters:
      factorX - x-scale-factor
      factorY - y-scale-factor
      center - relative Point for the scaling
      Returns:
      the new, scaled object

    • getScaled

      public Polyline getScaled(double factor, Point center)
      Description copied from interface: IScalable
      Scales a copy of the calling object by the given factor relative to the given center Point.
      Specified by:
      getScaled in interface IScalable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
      Parameters:
      factor - scale-factor
      center - relative Point for the scaling
      Returns:
      the new, scaled object

    • getTranslated

      public Polyline getTranslated(double dx, double dy)
      Description copied from interface: ITranslatable
      Translates a copy of this object by the given values in x and y direction.
      Specified by:
      getTranslated in interface ITranslatable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
      Parameters:
      dx - x-translation
      dy - y-translation
      Returns:
      a new, translated object

    • getTranslated

      public Polyline getTranslated(Point pt)
      Description copied from interface: ITranslatable
      Translates a copy of this object by the given Point.
      Specified by:
      getTranslated in interface ITranslatable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
      Parameters:
      pt - translation Point
      Returns:
      a new, translated object

    • rotateCCW

      public Polyline rotateCCW(Angle alpha)
      Rotates this AbstractPointListBasedGeometry counter-clockwise (CCW) by the given Angle around its centroid (see getCentroid()).
      Parameters:
      alpha - the rotation Angle
      Returns:
      this for convenience
      See Also:

    • rotateCCW

      public Polyline rotateCCW(Angle alpha, double cx, double cy)
      Rotates this AbstractPointListBasedGeometry counter-clockwise (CCW) by the given Angle around the Point specified by the passed-in x and y coordinates.
      Parameters:
      alpha - the rotation Angle
      cx - the x coordinate of the Point to rotate around
      cy - the y coordinate of the Point to rotate around
      Returns:
      this for convenience
      See Also:

    • rotateCCW

      public Polyline rotateCCW(Angle alpha, Point center)
      Rotates this AbstractPointListBasedGeometry counter-clockwise (CCW) by the given Angle around the given Point. The rotation is done by
      1. translating this AbstractPointListBasedGeometry by the negated Point center
      2. rotating each Point of this AbstractPointListBasedGeometry counter-clockwise by the given Angle
      3. translating this AbstractPointListBasedGeometry back by the Point center
      Parameters:
      alpha - the rotation Angle
      center - the Point to rotate around
      Returns:
      this for convenience

    • rotateCW

      public Polyline rotateCW(Angle alpha)
      Rotates this AbstractPointListBasedGeometry clockwise (CW) by the given Angle around its centroid (see getCentroid()).
      Parameters:
      alpha - the rotation Angle
      Returns:
      this for convenience
      See Also:

    • rotateCW

      public Polyline rotateCW(Angle alpha, double cx, double cy)
      Rotates this AbstractPointListBasedGeometry clockwise (CW) by the given Angle around the Point specified by the passed-in x and y coordinates.
      Parameters:
      alpha - the rotation Angle
      cx - the x coordinate of the Point to rotate around
      cy - the y coordinate of the Point to rotate around
      Returns:
      this for convenience
      See Also:

    • rotateCW

      public Polyline rotateCW(Angle alpha, Point center)
      Rotates this AbstractPointListBasedGeometry clockwise (CW) by the given Angle around the given Point. The rotation is done by
      1. translating this AbstractPointListBasedGeometry by the negated Point center
      2. rotating each Point of this AbstractPointListBasedGeometry clockwise by the given Angle
      3. translating this AbstractPointListBasedGeometry back by the Point center
      Parameters:
      alpha - the rotation Angle
      center - the Point to rotate around
      Returns:
      this for convenience

    • scale

      public Polyline scale(double factor)
      Description copied from interface: IScalable
      Scales the calling object by the given factor relative to its center Point.
      Specified by:
      scale in interface IScalable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
      Parameters:
      factor - scale-factor
      Returns:
      this for convenience

    • scale

      public Polyline scale(double fx, double fy)
      Description copied from interface: IScalable
      Scales the calling object by the given factors relative to the given center Point.
      Specified by:
      scale in interface IScalable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
      Parameters:
      fx - x-scale-factor
      fy - y-scale-factor
      Returns:
      this for convenience

    • scale

      public Polyline scale(double factor, double cx, double cy)
      Description copied from interface: IScalable
      Scales the calling object by the given factor relative to the given center Point (cx, cy).
      Specified by:
      scale in interface IScalable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
      Parameters:
      factor - scale-factor
      cx - x-coordinate of the relative Point for the scaling
      cy - y-coordinate of the relative Point for the scaling
      Returns:
      this for convenience

    • scale

      public Polyline scale(double fx, double fy, double cx, double cy)
      Description copied from interface: IScalable
      Scales the calling object by the given factors relative to the given center Point (cx, cy).
      Specified by:
      scale in interface IScalable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
      Parameters:
      fx - x-scale-factor
      fy - y-scale-factor
      cx - x-coordinate of the relative Point for the scaling
      cy - y-coordinate of the relative Point for the scaling
      Returns:
      this for convenience

    • scale

      public Polyline scale(double fx, double fy, Point center)
      Description copied from interface: IScalable
      Scales the calling object by the given factors relative to the given center Point.
      Specified by:
      scale in interface IScalable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
      Parameters:
      fx - x-scale-factor
      fy - y-scale-factor
      center - relative Point for the scaling
      Returns:
      this for convenience

    • scale

      public Polyline scale(double factor, Point center)
      Description copied from interface: IScalable
      Scales the calling object by the given factor relative to the given center Point.
      Specified by:
      scale in interface IScalable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
      Parameters:
      factor - scale-factor
      center - relative Point for the scaling
      Returns:
      this for convenience

    • translate

      public Polyline translate(double dx, double dy)
      Description copied from interface: ITranslatable
      Translates the object by the given values in x and y direction.
      Specified by:
      translate in interface ITranslatable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
      Parameters:
      dx - x-translation
      dy - y-translation
      Returns:
      this for convenience

    • translate

      public Polyline translate(Point p)
      Description copied from interface: ITranslatable
      Translates the object by the given Point.
      Specified by:
      translate in interface ITranslatable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
      Parameters:
      p - translation Point
      Returns:
      this for convenience

    • clone

      public Object clone()
      Overridden with public visibility as recommended within Cloneable .
      Overrides:
      clone in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object
      See Also:

    • touches

      public boolean touches(IGeometry g)
      Description copied from interface: IGeometry
      Returns true if the input IGeometry touches this IGeometry, i.e. there is at least one common point.
      Specified by:
      touches in interface IGeometry
      Parameters:
      g - The IGeometry for the intersection test
      Returns:
      true if the input IGeometry and this IGeometry have at least one common point.