| Title: | General Polygon Clipping Library for R |
|---|---|
| Description: | General polygon clipping routines for R based on Alan Murta's C library. Compatibility updates by Renova. |
| Authors: | Roger D. Peng <[email protected]> with contributions from Duncan Murdoch and Barry Rowlingson; GPC library by Alan Murta |
| Maintainer: | Roger D. Peng <[email protected]> |
| License: | file LICENSE |
| Version: | 1.5.6.9001 |
| Built: | 2026-11-13 18:02:19 UTC |
| Source: | https://github.com/renova-r/gpclib |
A class for representing polygons composed of multiple contours, some of which may be holes.
Objects can be created by calls of the form new("gpc.poly",
...) or by reading in from a file using read.polyfile.
Object of class “list”. Actually,
pts is a list of lists with length equal to the number of
contours in the "gpc.poly" object. Each element of
pts is a list of length 3 with names x, y,
and hole. x and y are vectors containing the
x and y coordinates, respectively, while hole is a logical
indicating whether or not the contour is a hole.
signature(x = "gpc.poly"): ...
signature(x = "gpc.poly", y = "gpc.poly"): ...
signature(object = "gpc.poly"): ...
signature(from = "matrix", to = "gpc.poly"): ...
signature(from = "data.frame", to = "gpc.poly"): ...
signature(from = "gpc.poly", to = "matrix"): ...
signature(from = "gpc.poly", to = "numeric"): ...
signature(from = "numeric", to = "gpc.poly"): ...
signature(from = "list", to = "gpc.poly"): ...
signature(x = "gpc.poly"): ...
signature(object = "gpc.poly"): ...
signature(x = "gpc.poly", y = "gpc.poly"): ...
signature(x = "gpc.poly"): The argument
poly.args can be used to pass a list of additional
arguments to be passed to the underlying polygon call.
signature(x = "gpc.poly"): ...
signature(x = "gpc.poly", y = "gpc.poly"): ...
signature(object = "gpc.poly"): Scale x and y
coordinates by amount xscale and yscale. By default
xscale equals yscale.
signature(x = "gpc.poly", y = "gpc.poly"): ...
signature(x = "gpc.poly"): ...
signature(x = "gpc.poly"): ...
The class "gpc.poly.nohole" is identical to
"gpc.poly" except the hole flag for each contour of a
"gpc.poly.nohole" object is always FALSE.
Roger D. Peng
## Make some random polygons set.seed(100) a <- cbind(rnorm(100), rnorm(100)) a <- a[chull(a), ] ## Convert `a' from matrix to "gpc.poly" a <- as(a, "gpc.poly") b <- cbind(rnorm(100), rnorm(100)) b <- as(b[chull(b), ], "gpc.poly") ## More complex polygons with an intersection p1 <- read.polyfile(system.file("poly-ex/ex-poly1.txt", package = "gpclib")) p2 <- read.polyfile(system.file("poly-ex/ex-poly2.txt", package = "gpclib")) ## Plot both polygons and highlight their intersection in red plot(append.poly(p1, p2)) plot(intersect(p1, p2), poly.args = list(col = 2), add = TRUE) ## Highlight the difference p1 \ p2 in green plot(setdiff(p1, p2), poly.args = list(col = 3), add = TRUE) ## Highlight the difference p2 \ p1 in blue plot(setdiff(p2, p1), poly.args = list(col = 4), add = TRUE) ## Plot the union of the two polygons plot(union(p1, p2)) ## Take the non-intersect portions and create a new polygon ## combining the two contours p.comb <- append.poly(setdiff(p1, p2), setdiff(p2, p1)) plot(p.comb, poly.args = list(col = 2, border = 0)) ## Coerce from a matrix x <- structure(c(0.0934073560027759, 0.192713393476752, 0.410062456627342, 0.470020818875781, 0.41380985426787, 0.271408743927828, 0.100902151283831, 0.0465648854961832, 0.63981588032221, 0.772382048331416, 0.753739930955121, 0.637744533947066, 0.455466052934407, 0.335327963176065, 0.399539700805524, 0.600460299194476), .Dim = c(8, 2)) y <- structure(c(0.404441360166551, 0.338861901457321, 0.301387925052047, 0.404441360166551, 0.531852879944483, 0.60117973629424, 0.625537820957668, 0.179976985040276, 0.341542002301496, 0.445109321058688, 0.610817031070196, 0.596317606444189, 0.459608745684695, 0.215189873417722), .Dim = c(7, 2)) x1 <- as(x, "gpc.poly") y1 <- as(y, "gpc.poly") plot(append.poly(x1, y1)) plot(intersect(x1, y1), poly.args = list(col = 2), add = TRUE) ## Show the triangulation plot(append.poly(x1, y1)) triangles <- triangulate(append.poly(x1,y1)) for (i in 0:(nrow(triangles)/3 - 1)) polygon(triangles[3*i + 1:3,], col="lightblue")## Make some random polygons set.seed(100) a <- cbind(rnorm(100), rnorm(100)) a <- a[chull(a), ] ## Convert `a' from matrix to "gpc.poly" a <- as(a, "gpc.poly") b <- cbind(rnorm(100), rnorm(100)) b <- as(b[chull(b), ], "gpc.poly") ## More complex polygons with an intersection p1 <- read.polyfile(system.file("poly-ex/ex-poly1.txt", package = "gpclib")) p2 <- read.polyfile(system.file("poly-ex/ex-poly2.txt", package = "gpclib")) ## Plot both polygons and highlight their intersection in red plot(append.poly(p1, p2)) plot(intersect(p1, p2), poly.args = list(col = 2), add = TRUE) ## Highlight the difference p1 \ p2 in green plot(setdiff(p1, p2), poly.args = list(col = 3), add = TRUE) ## Highlight the difference p2 \ p1 in blue plot(setdiff(p2, p1), poly.args = list(col = 4), add = TRUE) ## Plot the union of the two polygons plot(union(p1, p2)) ## Take the non-intersect portions and create a new polygon ## combining the two contours p.comb <- append.poly(setdiff(p1, p2), setdiff(p2, p1)) plot(p.comb, poly.args = list(col = 2, border = 0)) ## Coerce from a matrix x <- structure(c(0.0934073560027759, 0.192713393476752, 0.410062456627342, 0.470020818875781, 0.41380985426787, 0.271408743927828, 0.100902151283831, 0.0465648854961832, 0.63981588032221, 0.772382048331416, 0.753739930955121, 0.637744533947066, 0.455466052934407, 0.335327963176065, 0.399539700805524, 0.600460299194476), .Dim = c(8, 2)) y <- structure(c(0.404441360166551, 0.338861901457321, 0.301387925052047, 0.404441360166551, 0.531852879944483, 0.60117973629424, 0.625537820957668, 0.179976985040276, 0.341542002301496, 0.445109321058688, 0.610817031070196, 0.596317606444189, 0.459608745684695, 0.215189873417722), .Dim = c(7, 2)) x1 <- as(x, "gpc.poly") y1 <- as(y, "gpc.poly") plot(append.poly(x1, y1)) plot(intersect(x1, y1), poly.args = list(col = 2), add = TRUE) ## Show the triangulation plot(append.poly(x1, y1)) triangles <- triangulate(append.poly(x1,y1)) for (i in 0:(nrow(triangles)/3 - 1)) polygon(triangles[3*i + 1:3,], col="lightblue")
A class for representing polygons with multiple contours but without holes.
Objects can be created by calls of the form
‘new("gpc.poly.nohole", ...) or by calling read.polyfile’.
Object of class “list”. See the help for “gpc.poly” for details.
Class “gpc.poly”, directly.
signature(from = "numeric", to = "gpc.poly.nohole"): ...
This class is identical to “"gpc.poly"” and is needed because the
file formats for polygons without holes is slightly different from the
file format for polygons with holes. For a “gpc.poly.nohole”
object, the hole flag for each contour is always FALSE.
Also, write.polyfile will write the correct file format,
depending on whether the object is of class “gpc.poly” or
“gpc.poly.nohole”.
Roger D. Peng
## None## None
Some generic functions and methods for polygon objects
append.poly(x, y) area.poly(object, ...) get.pts(object) get.bbox(x) scale.poly(x, ...) tristrip(x) triangulate(x)append.poly(x, y) area.poly(object, ...) get.pts(object) get.bbox(x) scale.poly(x, ...) tristrip(x) triangulate(x)
x, object
|
A polygon object |
y |
A polygon object |
... |
Other arguments passed to methods |
The result of tristrip(x) is a list of two-column matrices. Each
matrix is a tristrip, i.e. the rows are vertices of triangles, with
each overlapping triple of rows corresponding to a separate triangle.
The result of triangulate(x) is a single two-column matrix. The
rows are vertices of triangles, taken in non-overlapping triples.
signature(x = "gpc.poly", y =
"gpc.poly"): Combine all contours of two "gpc.poly"
objects and return the combined polygon as a "gpc.poly"
object.
signature(object = "gpc.poly"): Compute and
return the sum of the areas of all contours in a "gpc.poly"
object.
signature(x = "gpc.poly"): Scale (divide)
the x and y coordinates of a "gpc.poly" object by the
amount xscale and yscale, respectively. Return a
scaled "gpc.poly" object.
signature(object = "gpc.poly"): Return the
list of x and y coordinates of the vertices of a "gpc.poly"
object.
signature(x = "gpc.poly"): Return the
bounding box for a "gpc.poly" object.
signature(x = "gpc.poly"): Return a tristrip
list for a "gpc.poly" object.
signature(x = "gpc.poly"): Return a matrix
of vertices of a triangulation of a "gpc.poly" object.
Roger D. Peng; GPC Library by Alan Murta; tristrip additions by Duncan Murdoch
"gpc.poly" class documentation.
holepoly <- read.polyfile(system.file("poly-ex/hole-poly.txt", package = "gpclib"), nohole = FALSE) area.poly(holepoly) stopifnot(area.poly(holepoly) == 8)holepoly <- read.polyfile(system.file("poly-ex/hole-poly.txt", package = "gpclib"), nohole = FALSE) area.poly(holepoly) stopifnot(area.poly(holepoly) == 8)
Read/Write polygon and contour information from/to a text file.
read.polyfile(filename, nohole = TRUE) write.polyfile(poly, filename = "GPCpoly.txt")read.polyfile(filename, nohole = TRUE) write.polyfile(poly, filename = "GPCpoly.txt")
filename |
the name of the file (a character string) from/to which data should be read/written. |
nohole |
Is this a polygon without holes? |
poly |
an object of class |
The text file representation of a polygon is of the following format:
<number of contours>
<number of points in first contour>
x1 y1
x2 y2
...
<number of points in second contour>
x1 y1
x2 y2
...
For example, a data file for a polygon with 2 contours (a four-sided object and a triangle) might look like:
2
4
1.0 1.0
1.0 2.0
3.4 3.21
10 11.2
3
21.0 11.2
22.3 99.2
4.5 5.4
The vertices of the polygon can be ordered either clockwise or counter-clockwise.
If a polygon has contours which are holes, then the format is slightly different. Basically, a flag is set to indicate that a particular contour is a hole. The format is
<number of contours>
<number of points in first contour>
<hole flag>
x1 y1
x2 y2
...
<number of points in second contour>
<hole flag>
x1 y1
x2 y2
...
The hole flag is either 1 to indicate a hole, or 0 for a regular contour. For example, a four-sided polygon with a triangular hole would be written as:
2
3
1
4.0 4.0
6.0 5.0
5.0 6.0
4
0
2.0 1.0
8.0 2.0
7.0 9.0
1.0 7.0
If nohole is TRUE (the default) read.polyfile
returns an object of class "gpc.poly.nohole". This object has
the hole flag set to FALSE for all contours. If nohole is
FALSE, then an object of class "gpc.poly" is
returned.
write.polyfile does not return anything useful.
Roger D. Peng
gpc.poly-class, gpc.poly.nohole-class
## None right now.## None right now.