Package org.eclipse.gef.geometry.planar
Class Polygon
- java.lang.Object
-
- org.eclipse.gef.geometry.planar.Polygon
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,IGeometry
,IRotatable<Polygon>
,IScalable<Polygon>
,IShape
,ITranslatable<Polygon>
public class Polygon extends java.lang.Object implements IShape
Represents the geometric shape of a convex polygon. 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 withinPrecisionUtils
) to compensate for rounding effects.- See Also:
- Serialized Form
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
Overridden with public visibility as recommended withinCloneable
.boolean
contains(double x, double y)
Checks whether the point that is represented by its x- and y-coordinates is contained within thisPolygon
.boolean
contains(IGeometry g)
boolean
contains(Line line)
boolean
contains(Point p)
boolean
contains(Polygon p)
boolean
contains(Polyline p)
boolean
contains(Rectangle r)
boolean
equals(java.lang.Object o)
boolean
equals(Point[] points)
Checks whether thisPolygon
and the one that is indirectly given via the given array of points are regarded to be equal.double
getArea()
Computes the area of thisPolygon
.Rectangle
getBounds()
Point
getCentroid()
Computes the centroid of thisAbstractPointListBasedGeometry
.double[]
getCoordinates()
Returns a double array which represents the sequence of coordinates of thePoint
s that make up thisAbstractPointListBasedGeometry
.Polygon
getCopy()
Returns a copy of thisPolygon
, which is made up by the same points.Polyline
getOutline()
Line[]
getOutlineSegments()
Point[]
getPoints()
Returns a copy of thePoint
s that make up thisAbstractPointListBasedGeometry
.T
getRotatedCCW(Angle alpha)
T
getRotatedCCW(Angle angle, double cx, double cy)
T
getRotatedCCW(Angle alpha, Point center)
T
getRotatedCW(Angle alpha)
T
getRotatedCW(Angle angle, double cx, double cy)
T
getRotatedCW(Angle alpha, Point center)
T
getScaled(double factor)
Scales a copy of the calling object by the given factor relative to its centerPoint
.T
getScaled(double factorX, double factorY)
Scales a copy of the calling object by the given factors relative to its centerPoint
.T
getScaled(double factor, double cx, double cy)
Scales a copy of the calling object by the given factor relative to the given centerPoint
(cx, cy).T
getScaled(double fx, double fy, double cx, double cy)
Scales a copy of the calling object by the given factors relative to the given centerPoint
(cx, cy).T
getScaled(double factorX, double factorY, Point center)
Scales a copy of the calling object by the given factors relative to the given centerPoint
.T
getScaled(double factor, Point center)
Scales a copy of the calling object by the given factor relative to the given centerPoint
.double
getSignedArea()
Computes the signed area of thisPolygon
.Polygon
getTransformed(AffineTransform t)
T
getTranslated(double dx, double dy)
Translates a copy of this object by the given values in x and y direction.T
getTranslated(Point pt)
Translates a copy of this object by the givenPoint
.Polygon[]
getTriangulation()
Naive, recursive ear-clipping algorithm to triangulate this simple, planarPolygon
.int
hashCode()
T
rotateCCW(Angle alpha)
Rotates thisAbstractPointListBasedGeometry
counter-clockwise (CCW) by the givenAngle
around its centroid (seegetCentroid()
).T
rotateCCW(Angle alpha, double cx, double cy)
T
rotateCCW(Angle alpha, Point center)
T
rotateCW(Angle alpha)
Rotates thisAbstractPointListBasedGeometry
clockwise (CW) by the givenAngle
around its centroid (seegetCentroid()
).T
rotateCW(Angle alpha, double cx, double cy)
T
rotateCW(Angle alpha, Point center)
T
scale(double factor)
Scales the calling object by the given factor relative to its centerPoint
.T
scale(double fx, double fy)
Scales the calling object by the given factors relative to the given centerPoint
.T
scale(double factor, double cx, double cy)
Scales the calling object by the given factor relative to the given centerPoint
(cx, cy).T
scale(double fx, double fy, double cx, double cy)
Scales the calling object by the given factors relative to the given centerPoint
(cx, cy).T
scale(double fx, double fy, Point center)
Scales the calling object by the given factors relative to the given centerPoint
.T
scale(double factor, Point center)
Scales the calling object by the given factor relative to the given centerPoint
.Path
toPath()
java.lang.String
toString()
boolean
touches(IGeometry g)
T
translate(double dx, double dy)
Translates the object by the given values in x and y direction.T
translate(Point p)
Translates the object by the givenPoint
.
-
-
-
Constructor Detail
-
Polygon
public Polygon(double... coordinates)
Constructs a newPolygon
from a even-numbered sequence of coordinates.- Parameters:
coordinates
- an alternating, even-numbered sequence of x and y coordinates, representing thePoint
s from which thePolygon
is to be created- See Also:
Polygon(Point...)
-
Polygon
public Polygon(Point... points)
Constructs a newPolygon
from the given sequence ofPoint
s. ThePolygon
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 thePolygon
is to be created.
-
-
Method Detail
-
contains
public boolean contains(double x, double y)
Checks whether the point that is represented by its x- and y-coordinates is contained within thisPolygon
.- Parameters:
x
- the x-coordinate of the point to testy
- the y-coordinate of the point to test- Returns:
true
if the point represented by its coordinates if contained within thisPolygon
,false
otherwise
-
contains
public boolean contains(Line line)
-
contains
public boolean contains(Polygon p)
-
contains
public boolean contains(Polyline p)
- Parameters:
p
- ThePolyline
to test for containment.- Returns:
- true if it is contained, false otherwise
-
contains
public boolean contains(Rectangle r)
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
equals
public boolean equals(Point[] points)
Checks whether thisPolygon
and the one that is indirectly given via the given array of points are regarded to be equal. ThePolygon
s will be regarded equal, if they are characterized by the same segments. As aPolygon
is always regarded to be closed, the list of points may not have to correspond in each index value, they may also be shifted by a certain offset. Moreover, the vertices of two equallyPolygon
s may be reverted in order.
-
getArea
public double getArea()
Computes the area of thisPolygon
.- Returns:
- the area of this
Polygon
-
getCopy
public Polygon getCopy()
Returns a copy of thisPolygon
, which is made up by the same points.
-
getOutline
public Polyline getOutline()
Description copied from interface:IShape
- Specified by:
getOutline
in interfaceIShape
- Returns:
- An
ICurve
representing thisIShape
's outline.
-
getOutlineSegments
public Line[] getOutlineSegments()
Returns a sequence ofLine
s, representing the segments that are obtained by linking each two successive point of thisPolygon
(including the last and the first one).- Specified by:
getOutlineSegments
in interfaceIShape
- Returns:
- an array of
Line
s, representing the segments that make up thisPolygon
-
getSignedArea
public double getSignedArea()
Computes the signed area of thisPolygon
. The sign of the area is negative for counter clockwise ordered vertices. It is positive for clockwise ordered vertices.- Returns:
- the signed area of this
Polygon
-
getTransformed
public Polygon getTransformed(AffineTransform t)
Default implementation returning a transformedPath
representation of thisIGeometry
. Subclasses may override this method to return a more specific representation.- Specified by:
getTransformed
in interfaceIGeometry
- Specified by:
getTransformed
in interfaceIShape
- Parameters:
t
- TheAffineTransform
to be applied- Returns:
- a transformed
Path
representation of thisIGeometry
- See Also:
IGeometry.getTransformed(AffineTransform)
-
getTriangulation
public Polygon[] getTriangulation()
Naive, recursive ear-clipping algorithm to triangulate this simple, planarPolygon
.- Returns:
- triangulation
Polygon
s (triangles)
-
toPath
public Path toPath()
Description copied from interface:IGeometry
- Specified by:
toPath
in interfaceIGeometry
- Returns:
- A new
Path
representation for thisIGeometry
. - See Also:
IGeometry.toPath()
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
getCentroid
public Point getCentroid()
Computes the centroid of thisAbstractPointListBasedGeometry
. The centroid is the "center of gravity", i.e. assuming aPolygon
is spanned by thePoint
s of thisAbstractPointListBasedGeometry
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 thisAbstractPointListBasedGeometry
-
getCoordinates
public final double[] getCoordinates()
Returns a double array which represents the sequence of coordinates of thePoint
s that make up thisAbstractPointListBasedGeometry
.- 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 thePoint
s that make up thisAbstractPointListBasedGeometry
.
-
getRotatedCCW
public T getRotatedCCW(Angle alpha)
Description copied from interface:IRotatable
Rotates the calling object by specifiedAngle
counter-clock-wise (CCW) around its centerPoint
. Does not necessarily return an object of the same type.- Specified by:
getRotatedCCW
in interfaceIRotatable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
- Parameters:
alpha
- rotationAngle
- Returns:
- an
IGeometry
representing the result of the rotation
-
getRotatedCCW
public T getRotatedCCW(Angle angle, double cx, double cy)
Description copied from interface:IRotatable
Rotates the calling object by the specifiedAngle
counter-clock-wise (CCW) around the specified centerPoint
(cx, cy). Does not necessarily return an object of the same type.- Specified by:
getRotatedCCW
in interfaceIRotatable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
- Parameters:
angle
- rotationAngle
cx
- x-coordinate of the relativePoint
for the rotationcy
- y-coordinate of the relativePoint
for the rotation- Returns:
- an
IGeometry
representing the result of the rotation
-
getRotatedCCW
public T getRotatedCCW(Angle alpha, Point center)
Description copied from interface:IRotatable
Rotates the calling object by the specifiedAngle
counter-clock-wise (CCW) around the specified centerPoint
. Does not necessarily return an object of the same type.- Specified by:
getRotatedCCW
in interfaceIRotatable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
- Parameters:
alpha
- rotationAngle
center
- relativePoint
for the rotation- Returns:
- an
IGeometry
representing the result of the rotation
-
getRotatedCW
public T getRotatedCW(Angle alpha)
Description copied from interface:IRotatable
Rotates the calling object by specifiedAngle
clock-wise (CW) around its centerPoint
. Does not necessarily return an object of the same type.- Specified by:
getRotatedCW
in interfaceIRotatable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
- Parameters:
alpha
- rotationAngle
- Returns:
- an
IGeometry
representing the result of the rotation
-
getRotatedCW
public T getRotatedCW(Angle angle, double cx, double cy)
Description copied from interface:IRotatable
Rotates the calling object by the specifiedAngle
clock-wise (CW) around the specified centerPoint
(cx, cy). Does not necessarily return an object of the same type.- Specified by:
getRotatedCW
in interfaceIRotatable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
- Parameters:
angle
- rotationAngle
cx
- x-coordinate of the relativePoint
for the rotationcy
- y-coordinate of the relativePoint
for the rotation- Returns:
- an
IGeometry
representing the result of the rotation
-
getRotatedCW
public T getRotatedCW(Angle alpha, Point center)
Description copied from interface:IRotatable
Rotates the calling object by the specifiedAngle
clock-wise (CW) around the specified centerPoint
. Does not necessarily return an object of the same type.- Specified by:
getRotatedCW
in interfaceIRotatable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
- Parameters:
alpha
- rotationAngle
center
- relativePoint
for the rotation- Returns:
- an
IGeometry
representing the result of the rotation
-
getScaled
public T getScaled(double factor)
Description copied from interface:IScalable
Scales a copy of the calling object by the given factor relative to its centerPoint
.
-
getScaled
public T getScaled(double factorX, double factorY)
Description copied from interface:IScalable
Scales a copy of the calling object by the given factors relative to its centerPoint
.
-
getScaled
public T 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 centerPoint
(cx, cy).- Specified by:
getScaled
in interfaceIScalable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
- Parameters:
factor
- scale-factorcx
- x-coordinate of the relativePoint
for the scalingcy
- y-coordinate of the relativePoint
for the scaling- Returns:
- the new, scaled object
-
getScaled
public T 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 centerPoint
(cx, cy).- Specified by:
getScaled
in interfaceIScalable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
- Parameters:
fx
- x-scale-factorfy
- y-scale-factorcx
- x-coordinate of the relativePoint
for the scalingcy
- y-coordinate of the relativePoint
for the scaling- Returns:
- the new, scaled object
-
getScaled
public T 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 centerPoint
.
-
getScaled
public T 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 centerPoint
.
-
getTranslated
public T 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 interfaceITranslatable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
- Parameters:
dx
- x-translationdy
- y-translation- Returns:
- a new, translated object
-
getTranslated
public T getTranslated(Point pt)
Description copied from interface:ITranslatable
Translates a copy of this object by the givenPoint
.- Specified by:
getTranslated
in interfaceITranslatable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
- Parameters:
pt
- translationPoint
- Returns:
- a new, translated object
-
rotateCCW
public T rotateCCW(Angle alpha)
Rotates thisAbstractPointListBasedGeometry
counter-clockwise (CCW) by the givenAngle
around its centroid (seegetCentroid()
).- Parameters:
alpha
- the rotationAngle
- Returns:
this
for convenience- See Also:
rotateCCW(Angle, Point)
-
rotateCCW
public T rotateCCW(Angle alpha, double cx, double cy)
Rotates thisAbstractPointListBasedGeometry
counter-clockwise (CCW) by the givenAngle
around thePoint
specified by the passed-in x and y coordinates.- Parameters:
alpha
- the rotationAngle
cx
- the x coordinate of thePoint
to rotate aroundcy
- the y coordinate of thePoint
to rotate around- Returns:
this
for convenience- See Also:
rotateCCW(Angle, Point)
-
rotateCW
public T rotateCW(Angle alpha)
Rotates thisAbstractPointListBasedGeometry
clockwise (CW) by the givenAngle
around its centroid (seegetCentroid()
).- Parameters:
alpha
- the rotationAngle
- Returns:
this
for convenience- See Also:
rotateCW(Angle, Point)
-
rotateCW
public T rotateCW(Angle alpha, double cx, double cy)
Rotates thisAbstractPointListBasedGeometry
clockwise (CW) by the givenAngle
around thePoint
specified by the passed-in x and y coordinates.- Parameters:
alpha
- the rotationAngle
cx
- the x coordinate of thePoint
to rotate aroundcy
- the y coordinate of thePoint
to rotate around- Returns:
this
for convenience- See Also:
rotateCW(Angle, Point)
-
scale
public T scale(double factor)
Description copied from interface:IScalable
Scales the calling object by the given factor relative to its centerPoint
.
-
scale
public T scale(double fx, double fy)
Description copied from interface:IScalable
Scales the calling object by the given factors relative to the given centerPoint
.
-
scale
public T scale(double factor, double cx, double cy)
Description copied from interface:IScalable
Scales the calling object by the given factor relative to the given centerPoint
(cx, cy).
-
scale
public T 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 centerPoint
(cx, cy).- Specified by:
scale
in interfaceIScalable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
- Parameters:
fx
- x-scale-factorfy
- y-scale-factorcx
- x-coordinate of the relativePoint
for the scalingcy
- y-coordinate of the relativePoint
for the scaling- Returns:
this
for convenience
-
scale
public T scale(double fx, double fy, Point center)
Description copied from interface:IScalable
Scales the calling object by the given factors relative to the given centerPoint
.
-
scale
public T scale(double factor, Point center)
Description copied from interface:IScalable
Scales the calling object by the given factor relative to the given centerPoint
.
-
translate
public T 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 interfaceITranslatable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
- Parameters:
dx
- x-translationdy
- y-translation- Returns:
this
for convenience
-
translate
public T translate(Point p)
Description copied from interface:ITranslatable
Translates the object by the givenPoint
.- Specified by:
translate
in interfaceITranslatable<T extends org.eclipse.gef.geometry.planar.AbstractPointListBasedGeometry<?>>
- Parameters:
p
- translationPoint
- Returns:
this
for convenience
-
clone
public java.lang.Object clone()
Overridden with public visibility as recommended withinCloneable
.- Overrides:
clone
in classjava.lang.Object
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
- See Also:
Object.hashCode()
-
-