# Polygon

### Related Docs: object Polygon | package vector

#### case class Polygon(jtsGeom: com.vividsolutions.jts.geom.Polygon) extends Geometry with TwoDimensions with Product with Serializable

Class representing a polygon

Linear Supertypes
Product, Equals, TwoDimensions, AtLeastOneDimension, Dimensions, Geometry, Serializable, Serializable, AnyRef, Any
Ordering
1. Alphabetic
2. By Inheritance
Inherited
1. Polygon
2. Product
3. Equals
4. TwoDimensions
5. AtLeastOneDimension
6. Dimensions
7. Geometry
8. Serializable
9. Serializable
10. AnyRef
11. Any
1. Hide All
2. Show All
Visibility
1. Public
2. All

### Value Members

1. #### final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
2. #### final def ##(): Int

Definition Classes
AnyRef → Any
3. #### def &(g: TwoDimensions): TwoDimensionsTwoDimensionsIntersectionResult

Computes a Result that represents a Geometry made up of the points shared by this Polygon and g.

4. #### def &(g: OneDimension): OneDimensionAtLeastOneDimensionIntersectionResult

Computes a Result that represents a Geometry made up of the points shared by this Polygon and g.

5. #### def &(mp: MultiPoint): MultiPointAtLeastOneDimensionIntersectionResult

Computes a Result that represents a Geometry made up of the points shared by this Polygon and mp.

6. #### def &(p: Point): PointOrNoResult

Computes a Result that represents a Geometry made up of the points shared by this Polygon and p.

7. #### def &(g: Geometry): TwoDimensionsTwoDimensionsIntersectionResult

Definition Classes
Geometry
8. #### def -(g: TwoDimensions): TwoDimensionsTwoDimensionsDifferenceResult

Computes a Result that represents a Geometry made up of all the points in this Polygon that are not in g.

9. #### def -(g: AtMostOneDimension): PolygonAtMostOneDimensionDifferenceResult

Computes a Result that represents a Geometry made up of all the points in this Polygon that are not in g.

10. #### final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
11. #### lazy val area: Double

Returns the area of this Polygon.

12. #### def as[G <: Geometry](implicit arg0: ClassTag[G]): Option[G]

Attempt to convert this Geometry to the provided type

Attempt to convert this Geometry to the provided type

Definition Classes
Geometry
13. #### final def asInstanceOf[T0]: T0

Definition Classes
Any
14. #### lazy val boundary: PolygonBoundaryResult

Returns the boundary of this Polygon.

Returns the boundary of this Polygon. The boundary of a Polygon is the set of closed curves corresponding to its exterior and interior boundaries.

15. #### def buffer(d: Double): Polygon

Computes a buffer area around this Polygon having width d.

16. #### def centroid: PointOrNoResult

Calculate centroid of this Geometry

Calculate centroid of this Geometry

Definition Classes
Geometry
17. #### def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
18. #### def contains(g: Geometry): Boolean

Tests whether this Polygon contains the specified Geometry g.

Tests whether this Polygon contains the specified Geometry g. Returns true if the DE-9IM Intersection Matrix for the two geometries is T*****FF*.

19. #### def coveredBy(g: TwoDimensions): Boolean

Tests whether this Polygon is covered by the specified TwoDimensions g.

Tests whether this Polygon is covered by the specified TwoDimensions g. Returns true if the DE-9IM Intersection Matrix for the two geometries is T*F**F*** or *TF**F*** or **FT*F*** or **F*TF***.

20. #### def covers(g: Geometry): Boolean

Tests whether this Polygon covers the specified Geometry g.

Tests whether this Polygon covers the specified Geometry g. Returns true if the DE-9IM Intersection Matrix for the two geometries is T*****FF* or *T****FF* or ***T**FF* or ****T*FF*.

21. #### def crosses(g: OneDimension): Boolean

Tests whether this Polygon crosses the specified OneDimension g.

Tests whether this Polygon crosses the specified OneDimension g. Returns true if the DE-9IM Intersection Matrix for the two geometries is T*****T** (A/L).

22. #### def crosses(mp: MultiPoint): Boolean

Tests whether this Polygon crosses the specified MultiPoint mp.

Tests whether this Polygon crosses the specified MultiPoint mp. Returns true if the DE-9IM Intersection Matrix for the two geometries is T*****T** (A/P).

23. #### def difference(g: TwoDimensions): TwoDimensionsTwoDimensionsDifferenceResult

Computes a Result that represents a Geometry made up of all the points in this Polygon that are not in g.

24. #### def difference(g: AtMostOneDimension): PolygonAtMostOneDimensionDifferenceResult

Computes a Result that represents a Geometry made up of all the points in this Polygon that are not in g.

25. #### def disjoint(other: Geometry): Boolean

Definition Classes
Geometry
26. #### def distance(other: Geometry): Double

Calculate the distance to another Geometry

Calculate the distance to another Geometry

Definition Classes
Geometry
27. #### def envelope: Extent

Definition Classes
Geometry
28. #### final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
29. #### def equals(other: Any): Boolean

Definition Classes
Geometry → AnyRef → Any
30. #### lazy val exterior: Line

Returns the exterior ring of this Polygon.

31. #### def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
32. #### final def getClass(): Class[_]

Definition Classes
AnyRef → Any
33. #### lazy val hasHoles: Boolean

Returns true if this Polygon contains holes

34. #### def hashCode(): Int

Definition Classes
Geometry → AnyRef → Any
35. #### lazy val holes: Array[Line]

Returns the hole rings of this Polygon.

36. #### def interiorPoint: PointOrNoResult

Definition Classes
Geometry
37. #### def intersection(g: TwoDimensions): TwoDimensionsTwoDimensionsIntersectionResult

Computes a Result that represents a Geometry made up of the points shared by this Polygon and g.

38. #### def intersection(g: OneDimension): OneDimensionAtLeastOneDimensionIntersectionResult

Computes a Result that represents a Geometry made up of the points shared by this Polygon and g.

39. #### def intersection(mp: MultiPoint): MultiPointAtLeastOneDimensionIntersectionResult

Computes a Result that represents a Geometry made up of the points shared by this Polygon and mp.

40. #### def intersection(p: Point): PointOrNoResult

Computes a Result that represents a Geometry made up of the points shared by this Polygon and p.

41. #### def intersection(g: Geometry): TwoDimensionsTwoDimensionsIntersectionResult

Computes a Result that represents a Geometry made up of the points shared by this Polygon and g.

Computes a Result that represents a Geometry made up of the points shared by this Polygon and g.

Definition Classes
Geometry
42. #### def intersectionSafe(g: TwoDimensions): TwoDimensionsTwoDimensionsIntersectionResult

Computes a Result that represents a Geometry made up of the points shared by this Polygon and g.

Computes a Result that represents a Geometry made up of the points shared by this Polygon and g. If it fails, it reduces the precision to avoid TopologyException.

43. #### def intersectionSafe(g: OneDimension): OneDimensionAtLeastOneDimensionIntersectionResult

Computes a Result that represents a Geometry made up of the points shared by this Polygon and g.

Computes a Result that represents a Geometry made up of the points shared by this Polygon and g. If it fails, it reduces the precision to avoid TopologyException.

44. #### def intersectionSafe(mp: MultiPoint): MultiPointAtLeastOneDimensionIntersectionResult

Computes a Result that represents a Geometry made up of the points shared by this Polygon and g.

Computes a Result that represents a Geometry made up of the points shared by this Polygon and g. If it fails, it reduces the precision to avoid TopologyException.

45. #### def intersectionSafe(p: Point): PointOrNoResult

Computes a Result that represents a Geometry made up of the points shared by this Polygon and g.

Computes a Result that represents a Geometry made up of the points shared by this Polygon and g. If it fails, it reduces the precision to avoid TopologyException.

46. #### def intersectionSafe(g: Geometry): TwoDimensionsTwoDimensionsIntersectionResult

Computes a Result that represents a Geometry made up of the points shared by this Polygon and g.

Computes a Result that represents a Geometry made up of the points shared by this Polygon and g. If it fails, it reduces the precision to avoid TopologyException.

Definition Classes
Geometry
47. #### def intersects(other: Geometry): Boolean

Definition Classes
Geometry
48. #### def isEmpty: Boolean

Is this Geometry empty? This is faster than checking manually like:

Is this Geometry empty? This is faster than checking manually like:

```val mp: MultiPoint = ...
val ps: Array[Point] = mp.points  // `.points` is a lazy val with processing overhead

ps.isEmpty  // possible, but mp.isEmpty is faster```

It would be similar for MultiLine or MultiPolygon.

Definition Classes
Geometry
49. #### final def isInstanceOf[T0]: Boolean

Definition Classes
Any
50. #### lazy val isRectangle: Boolean

Tests whether this Polygon is a rectangle.

51. #### def isValid: Boolean

Check the validity of this geometry

Check the validity of this geometry

Definition Classes
Geometry
52. #### val jtsGeom: com.vividsolutions.jts.geom.Polygon

Return the wrapped jts Geometry

Return the wrapped jts Geometry

Definition Classes
PolygonDimensionsGeometry
53. #### final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
54. #### def normalized(): Polygon

Returns a unique representation of the geometry based on standard coordinate ordering.

55. #### final def notify(): Unit

Definition Classes
AnyRef
56. #### final def notifyAll(): Unit

Definition Classes
AnyRef
57. #### lazy val numberOfHoles: Int

Returns the number of holes in this Polygon

58. #### def overlaps(g: TwoDimensions): Boolean

Tests whether this Polygon overlaps the specified TwoDimensions g.

Tests whether this Polygon overlaps the specified TwoDimensions g. Returns true if The DE-9IM Intersection Matrix for the two geometries is T*T***T**.

59. #### lazy val perimeter: Double

Returns this Polygon's perimeter.

Returns this Polygon's perimeter. A Polygon's perimeter is the length of its exterior and interior boundaries.

60. #### def populatePoints(sequence: CoordinateSequence, arr: Array[Point], offset: Int = 0): Array[Point]

Attributes
protected
Definition Classes
Geometry
61. #### def symDifference(g: TwoDimensions): TwoDimensionsTwoDimensionsSymDifferenceResult

Computes a Result that represents a Geometry made up of all the points in this Polygon that are not in g and all the points in g that are not in this Polygon.

62. #### def symDifference(g: AtMostOneDimension): AtMostOneDimensionPolygonSymDifferenceResult

Computes a Result that represents a Geometry made up of all the points in this Polygon that are not in g and all the points in g that are not in this Polygon.

63. #### final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
64. #### def toString(): String

Definition Classes
Geometry → AnyRef → Any
65. #### def touches(g: Geometry): Boolean

Tests whether this Polygon touches the specified Geometry g.

Tests whether this Polygon touches the specified Geometry g. Returns true if the DE-9IM Intersection Matrix for the two geometries is FT*******, F**T***** or F***T****.

66. #### def union(g: TwoDimensions): TwoDimensionsTwoDimensionsUnionResult

Computes a Result that represents a Geometry made up of all the points in this Polygon and g.

Computes a Result that represents a Geometry made up of all the points in this Polygon and g. Uses cascaded polygon union if g is a (multi)polygon else falls back to default jts union method.

67. #### def union(g: AtMostOneDimension): AtMostOneDimensionPolygonUnionResult

Computes a Result that represents a Geometry made up of all the points in this Polygon and g.

68. #### lazy val vertexCount: Int

Get the number of vertices in this geometry

Get the number of vertices in this geometry

Definition Classes
Geometry
69. #### lazy val vertices: Array[Point]

Returns this Polygon's vertices.

Returns this Polygon's vertices.

Definition Classes
PolygonGeometry
70. #### final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
71. #### final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
72. #### final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
73. #### def within(g: TwoDimensions): Boolean

Tests whether this Polygon is within the specified TwoDimensions g.

Tests whether this Polygon is within the specified TwoDimensions g. Returns true if the DE-9IM Intersection Matrix for the two geometries is T*F**F***.

74. #### def withinDistance(other: Geometry, dist: Double): Boolean

Determine whether another Geometry is within a given distance

Determine whether another Geometry is within a given distance

other

The geometry to check

dist

The radius of the circle within which this check is conducted

Definition Classes
Geometry
75. #### def |(g: TwoDimensions): TwoDimensionsTwoDimensionsUnionResult

Computes a Result that represents a Geometry made up of all the points in this Polygon and g.

76. #### def |(g: AtMostOneDimension): AtMostOneDimensionPolygonUnionResult

Computes a Result that represents a Geometry made up of all the points in this Polygon and g.