polyclip: Perform Geometric Operations on Coordinates

In gridGeometry: Polygon Geometry in 'grid'

Perform Geometric Operations on Coordinates

Description

This function combines two sets of coordinates using one of the following operations: intersection, union, minus, and xor.

Usage

polyclip(A, B, ...)
## S3 method for class 'grob'
polyclip(A, B, op="intersection", closed=TRUE,
         reduceA = if (closed) "union" else "flatten",
         reduceB = "union",
         fillA = NULL, fillB = NULL,
         ...)
## S3 method for class 'gList'
polyclip(A, B, op="intersection", closed=TRUE,
         reduceA = if (closed) "union" else "flatten",
         reduceB = "union",
         fillA = NULL, fillB = NULL,
         ...)
## S3 method for class 'gPath'
polyclip(A, B, op="intersection", closed=TRUE,
                         strict=FALSE, grep=FALSE, global=FALSE,
         reduceA = if (closed) "union" else "flatten",
         reduceB = "union",
         fillA = NULL, fillB = NULL,
         ...)
## S3 method for class 'character'
polyclip(A, B, op="intersection", closed=TRUE,
                             strict=FALSE, grep=FALSE, global=FALSE,
         reduceA = if (closed) "union" else "flatten",
         reduceB = "union",
         fillA = NULL, fillB = NULL,
         ...)

Arguments

A	A set of coordinates describing the subject shape. Or a grob, gList, or a gPath (or a character value) identifying a grob that has already been drawn from which coordinates are generated.
B	A set of coordinates describing the clip shape. Or a grob, gList, or a gPath (or a character value) identifying a grob that has already been drawn from which coordinates are generated.
op	A character value describing the operation. One of "intersection", "minus", "union", or "xor".
closed	A logical value indicating whether the A coordinates describe a closed shape or an open shape.
reduceA, reduceB	A character value describing the operation to be used if either A or B need to be reduced to a single set of coordinates. One of "intersection", "minus", "union", or "xor", in which case polyclip is used to reduce multiple shapes, or "flatten", in which case coordinates for all shapes are returned.
fillA, fillB	A character value describing the fill rule. Possible values are "winding" or "evenodd" or NULL. In the latter case (the default), the fill rule will be taken from the coordinates if the coordinates have a "rule" attribute. Otherwise, the default is "winding".
strict, grep, global	Arguments controlling the interpretation of the gPath (passed to grid.get).
...	Arguments used by methods.

Details

The subject coordinates are combined with the clip coordinates using the op operation.

Value

The result is a new set of coordinates.

Author(s)

Paul Murrell

See Also

polyclip

Examples

r <- rectGrob(x=1/3, y=1/3, width=.4, height=.4)
c <- circleGrob(x=2/3, y=2/3, r=.2)
polyclip(r, c)

gridGeometry documentation built on March 21, 2022, 1:05 a.m.