S2CellId (Google S2 geometry library 1.0.0 API)

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

All Implemented Interfaces:: Comparable<S2CellId>

public final class S2CellId
extends Object
implements Comparable<S2CellId>

Field Summary

Fields
Modifier and Type Field and Description

static int FACE_BITS

static int MAX_LEVEL

static int MAX_SIZE

static long MAX_UNSIGNED

static int NUM_FACES

static int POS_BITS

Fields
Modifier and Type	Field and Description
`static int`	`FACE_BITS`
`static int`	`MAX_LEVEL`
`static int`	`MAX_SIZE`
`static long`	`MAX_UNSIGNED`
`static int`	`NUM_FACES`
`static int`	`POS_BITS`

Constructor Summary

Constructors
Constructor and Description

S2CellId()

S2CellId(long id)

Constructors
Constructor and Description
`S2CellId()`
`S2CellId(long id)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static S2CellId`	`begin(int level)`
`S2CellId`	`childBegin()`
`S2CellId`	`childBegin(int level)`
`S2CellId`	`childEnd()`
`S2CellId`	`childEnd(int level)`
`int`	`childPosition(int level)`
`int`	`compareTo(S2CellId that)`
`boolean`	`contains(S2CellId other)`
`static S2CellId`	`end(int level)`
`boolean`	`equals(Object that)`
`int`	`face()`
`static S2CellId`	`fromFaceIJ(int face, int i, int j)`
`static S2CellId`	`fromFaceIJSame(int face, int i, int j, boolean sameFace)`
`static S2CellId`	`fromFacePosLevel(int face, long pos, int level)`
`static S2CellId`	`fromLatLng(S2LatLng ll)`
`static S2CellId`	`fromPoint(S2Point p)`
`static S2CellId`	`fromToken(String token)`
`void`	`getAllNeighbors(int nbrLevel, List<S2CellId> output)`
`void`	`getEdgeNeighbors(S2CellId[] neighbors)`
`void`	`getVertexNeighbors(int level, List<S2CellId> output)`
`boolean`	`greaterOrEquals(S2CellId x)`
`boolean`	`greaterThan(S2CellId x)`
`int`	`hashCode()`
`long`	`id()`
`boolean`	`intersects(S2CellId other)`
`boolean`	`isFace()`
`boolean`	`isLeaf()`
`boolean`	`isValid()`
`boolean`	`lessOrEquals(S2CellId x)`
`boolean`	`lessThan(S2CellId x)`
`int`	`level()`
`long`	`lowestOnBit()`
`static long`	`lowestOnBitForLevel(int level)`
`S2CellId`	`next()`
`S2CellId`	`nextWrap()`
`static S2CellId`	`none()`
`S2CellId`	`parent()`
`S2CellId`	`parent(int level)`
`long`	`pos()`
`S2CellId`	`prev()`
`S2CellId`	`prevWrap()`
`S2CellId`	`rangeMax()`
`S2CellId`	`rangeMin()`
`static S2CellId`	`sentinel()`
`int`	`toFaceIJOrientation(MutableInteger pi, MutableInteger pj, MutableInteger orientation)`
`S2LatLng`	`toLatLng()`
`S2Point`	`toPoint()`
`S2Point`	`toPointRaw()`
`String`	`toString()`
`String`	`toToken()`
`static boolean`	`unsignedLongGreaterThan(long x1, long x2)`
`static boolean`	`unsignedLongLessThan(long x1, long x2)`

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

Field Detail

FACE_BITS
```
public static final int FACE_BITS
```

NUM_FACES
```
public static final int NUM_FACES
```

MAX_LEVEL
```
public static final int MAX_LEVEL
```

POS_BITS
```
public static final int POS_BITS
```

MAX_SIZE
```
public static final int MAX_SIZE
```

MAX_UNSIGNED
```
public static final long MAX_UNSIGNED
```

Constructor Detail

S2CellId
```
public S2CellId(long id)
```

S2CellId
```
public S2CellId()
```

Method Detail

none
```
public static S2CellId none()
```

sentinel
```
public static S2CellId sentinel()
```

fromFacePosLevel

public static S2CellId fromFacePosLevel(int face,
                                        long pos,
                                        int level)

fromPoint

public static S2CellId fromPoint(S2Point p)

fromLatLng

public static S2CellId fromLatLng(S2LatLng ll)

toPoint
```
public S2Point toPoint()
```

toPointRaw
```
public S2Point toPointRaw()
```

toLatLng
```
public S2LatLng toLatLng()
```

id
```
public long id()
```

isValid
```
public boolean isValid()
```

face
```
public int face()
```

pos
```
public long pos()
```

level
```
public int level()
```

isLeaf
```
public boolean isLeaf()
```

isFace
```
public boolean isFace()
```

childPosition
```
public int childPosition(int level)
```

rangeMin
```
public S2CellId rangeMin()
```

rangeMax
```
public S2CellId rangeMax()
```

contains

public boolean contains(S2CellId other)

intersects

public boolean intersects(S2CellId other)

parent
```
public S2CellId parent()
```

parent
```
public S2CellId parent(int level)
```

childBegin
```
public S2CellId childBegin()
```

childBegin

public S2CellId childBegin(int level)

childEnd
```
public S2CellId childEnd()
```

childEnd
```
public S2CellId childEnd(int level)
```

next
```
public S2CellId next()
```

prev
```
public S2CellId prev()
```

nextWrap
```
public S2CellId nextWrap()
```

prevWrap
```
public S2CellId prevWrap()
```

begin

public static S2CellId begin(int level)

end

public static S2CellId end(int level)

fromToken

public static S2CellId fromToken(String token)

toToken
```
public String toToken()
```

getEdgeNeighbors

public void getEdgeNeighbors(S2CellId[] neighbors)

getVertexNeighbors

public void getVertexNeighbors(int level,
                               List<S2CellId> output)

getAllNeighbors

public void getAllNeighbors(int nbrLevel,
                            List<S2CellId> output)

fromFaceIJ

public static S2CellId fromFaceIJ(int face,
                                  int i,
                                  int j)

toFaceIJOrientation

public int toFaceIJOrientation(MutableInteger pi,
                               MutableInteger pj,
                               MutableInteger orientation)

lowestOnBit
```
public long lowestOnBit()
```

lowestOnBitForLevel

public static long lowestOnBitForLevel(int level)

fromFaceIJSame

public static S2CellId fromFaceIJSame(int face,
                                      int i,
                                      int j,
                                      boolean sameFace)

equals
```
public boolean equals(Object that)
```

unsignedLongLessThan

public static boolean unsignedLongLessThan(long x1,
                                           long x2)

unsignedLongGreaterThan

public static boolean unsignedLongGreaterThan(long x1,
                                              long x2)

lessThan
```
public boolean lessThan(S2CellId x)
```

greaterThan

public boolean greaterThan(S2CellId x)

lessOrEquals

public boolean lessOrEquals(S2CellId x)

greaterOrEquals

public boolean greaterOrEquals(S2CellId x)

hashCode
```
public int hashCode()
```

toString
```
public String toString()
```

compareTo
```
public int compareTo(S2CellId that)
```

Class S2CellId

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FACE_BITS

NUM_FACES

MAX_LEVEL

POS_BITS

MAX_SIZE

MAX_UNSIGNED

Constructor Detail

S2CellId

S2CellId

Method Detail

none

sentinel

fromFacePosLevel

fromPoint

fromLatLng

toPoint

toPointRaw

toLatLng

id

isValid

face

pos

level

isLeaf

isFace

childPosition

rangeMin

rangeMax

contains

intersects

parent

parent

childBegin

childBegin

childEnd

childEnd

next

prev

nextWrap

prevWrap

begin

end

fromToken

toToken

getEdgeNeighbors

getVertexNeighbors

getAllNeighbors

fromFaceIJ

toFaceIJOrientation

lowestOnBit

lowestOnBitForLevel

fromFaceIJSame

equals

unsignedLongLessThan

unsignedLongGreaterThan

lessThan

greaterThan

lessOrEquals

greaterOrEquals

hashCode

toString

compareTo