S2Shape.ReferencePoint (S2 Geometry Library for Java 2.0.0 API)

java.lang.Object
- com.google.common.geometry.S2Point
- - com.google.common.geometry.S2Shape.ReferencePoint

All Implemented Interfaces:

S2Region, Serializable, Comparable<S2Point>

Enclosing interface:

S2Shape
```
public abstract static class S2Shape.ReferencePoint
extends S2Point
```
A point with a known containment relationship.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.common.geometry.S2Point
  S2Point.Builder, S2Point.Shape

Field Summary
- Fields inherited from class com.google.common.geometry.S2Point
  ORIGIN, X_NEG, X_POS, Y_NEG, Y_POS, Z_NEG, Z_POS

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract boolean`	`contained()`	Returns true if this point is contained by the reference shape.
`static S2Shape.ReferencePoint`	`create(boolean contained)`	Returns a referenced point at an arbitrary position, suitable for shapes that contain all points or no points.
`static S2Shape.ReferencePoint`	`create(S2Point p, boolean contained)`	Creates a referenced point at position 'p', with known containment 'contained'.
`boolean`	`equals(Object o)`

Methods inherited from class com.google.common.geometry.S2Point
add, add, angle, compareTo, contains, contains, crossProd, crossProd, crossProdNorm, decode, div, div, dotProd, encode, equalsPoint, fabs, fabs, get, getCapBound, getDistance, getDistance2, getRectBound, getX, getY, getZ, hashCode, largestAbsComponent, lessThan, mayIntersect, minus, mul, mul, neg, neg, norm, norm2, normalize, normalize, ortho, rotate, scalarTripleProduct, sub, sub, toBuilder, toDegreesString, toString

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

- Method Detail
  - contained
```
public abstract boolean contained()
```
    Returns true if this point is contained by the reference shape.
  - create
```
public static S2Shape.ReferencePoint create(boolean contained)
```
    Returns a referenced point at an arbitrary position, suitable for shapes that contain all points or no points.
  - create
```
public static S2Shape.ReferencePoint create(S2Point p,
                                            boolean contained)
```
    Creates a referenced point at position 'p', with known containment 'contained'.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class S2Point