S2ContainsPointQuery (S2 Geometry Library for Java 2.0.0 API)

java.lang.Object
- com.google.common.geometry.S2ContainsPointQuery

```
@GwtCompatible
public class S2ContainsPointQuery
extends Object
```
A query for whether one or more shapes in an S2ShapeIndex contain a given S2Point.
The S2ShapeIndex may contain any number of points, polylines, and/or polygons (possibly overlapping). Shape boundaries are modeled with a constructor parameter, S2ContainsPointQuery.S2VertexModel, which defaults to S2ContainsPointQuery.S2VertexModel.SEMI_OPEN. This may be customized to control whether or not shapes are considered to contain their vertices.
This class is not thread-safe. To use it in parallel, each thread should construct its own instance (this is not expensive). However, note that if you need to do a large number of point containment tests, it is more efficient to re-use the S2ContainsPointQuery object rather than constructing a new one each time.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`S2ContainsPointQuery.Options`	The options for building an S2ContainsPointQuery.
`static class`	`S2ContainsPointQuery.S2VertexModel`	A rule for whether shapes are considered to contain their vertices.

Constructor Summary

Constructors
Constructor	Description
`S2ContainsPointQuery(S2ShapeIndex index)`	Constructs a semi-open contains-point query from the given iterator.
`S2ContainsPointQuery(S2ShapeIndex index, S2ContainsPointQuery.Options options)`	Constructs a contains-point query from the given iterator, with the specified options.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`contains(S2Point p)`	Returns true if any shape in the given iterator contains `p` under the specified `S2ContainsPointQuery.S2VertexModel`.
`Iterable<S2Shape>`	`getContainingShapes(S2Point p)`	A convenience function that returns all the shapes that contain `p`.
`S2ContainsPointQuery.Options`	`options()`	Returns the options used to build this query.
`boolean`	`shapeContains(S2Shape shape, S2Point p)`	Returns true if the given shape contains `p` under the specified `S2ContainsPointQuery.S2VertexModel`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - S2ContainsPointQuery
```
public S2ContainsPointQuery(S2ShapeIndex index)
```
    Constructs a semi-open contains-point query from the given iterator.
  - S2ContainsPointQuery
```
public S2ContainsPointQuery(S2ShapeIndex index,
                            S2ContainsPointQuery.Options options)
```
    Constructs a contains-point query from the given iterator, with the specified options.
- Method Detail
  - options
```
public S2ContainsPointQuery.Options options()
```
    Returns the options used to build this query.
  - contains
```
public boolean contains(S2Point p)
```
    Returns true if any shape in the given iterator contains p under the specified S2ContainsPointQuery.S2VertexModel.
  - shapeContains
```
public boolean shapeContains(S2Shape shape,
                             S2Point p)
```
    Returns true if the given shape contains p under the specified S2ContainsPointQuery.S2VertexModel.
  - getContainingShapes
```
public Iterable<S2Shape> getContainingShapes(S2Point p)
```
    A convenience function that returns all the shapes that contain p.