Class Cell

constructor

• new Cell(
      face: number,
      level: number,
      orientation: number,
      id: bigint,
      uv: r2.Rect,
  ): Cell

  Returns a new Cell.

  Parameters

  • face: number
  • level: number
  • orientation: number
  • id: bigint
  • uv: r2.Rect

  Returns Cell

StaticfromCellID

• fromCellID(id: bigint): Cell

  Constructs a Cell corresponding to the given CellID.

  Parameters

  • id: bigint

  Returns Cell

StaticfromLatLng

• fromLatLng(ll: LatLng): Cell

  Constructs a cell for the given LatLng.

  Parameters

  • ll: LatLng

  Returns Cell

StaticfromPoint

• fromPoint(p: s2.Point): Cell

  Constructs a cell for the given Point.

  Parameters

  • p: s2.Point

  Returns Cell

face

id

level

orientation

uv

approxArea

• approxArea(): number

  Returns the approximate area of this cell. This method is accurate to within 3% percent for all cell sizes and accurate to within 0.1% for cells at level 5 or higher (i.e. squares 350km to a side or smaller on the Earth's surface). It is moderately cheap to compute.

  Returns number

averageArea

• averageArea(): number

  Returns the average area of cells at the level of this cell. This is accurate to within a factor of 1.7.

  Returns number

boundaryDistance

• boundaryDistance(target: s2.Point): number

  Reports the distance from the cell boundary to the given point.

  Parameters

  • target: s2.Point

  Returns number

boundUV

• boundUV(): r2.Rect

  Returns the bounds of this cell in (u,v)-space.

  Returns r2.Rect

capBound

• capBound(): Cap

  Returns the bounding cap of this cell.

  Returns Cap

cellUnionBound

• cellUnionBound(): bigint[]

  Computes a covering of the Cell.

  Returns bigint[]

center

• center(): s2.Point

  Returns the direction vector corresponding to the center in (s,t)-space of the given cell. This is the point at which the cell is divided into four subcells; it is not necessarily the centroid of the cell in (u,v)-space or (x,y,z)-space

  Returns s2.Point

children

• children(): Cell[]

  Returns the four direct children of this cell in traversal order and returns true. If this is a leaf cell, or the children could not be created, false is returned. The C++ method is called Subdivide.

  Returns Cell[]

containsCell

• containsCell(oc: Cell): boolean

  Reports whether this cell contains the other cell.

  Parameters

  • oc: Cell

  Returns boolean

containsPoint

• containsPoint(p: s2.Point): boolean

  Reports whether this cell contains the given point. Note that unlike Loop/Polygon, a Cell is considered to be a closed set. This means that a point on a Cell's edge or vertex belongs to the Cell and the relevant adjacent Cells too.

  If you want every point to be contained by exactly one Cell, you will need to convert the Cell to a Loop.

  Parameters

  • p: s2.Point

  Returns boolean

distance

• distance(target: s2.Point): number

  Reports the distance from the cell to the given point. Returns zero if the point is inside the cell.

  Parameters

  • target: s2.Point

  Returns number

distanceInternal

• distanceInternal(targetXYZ: s2.Point, toInterior: boolean): number

  Reports the distance from the given point to the interior of the cell if toInterior is true or to the boundary of the cell otherwise.

  Parameters

  • targetXYZ: s2.Point
  • toInterior: boolean

  Returns number

distanceToCell

• distanceToCell(target: Cell): number

  Returns the minimum distance from this cell to the given cell. It returns zero if one cell contains the other.

  Parameters

  • target: Cell

  Returns number

distanceToEdge

• distanceToEdge(a: s2.Point, b: s2.Point): number

  Returns the minimum distance from the cell to the given edge AB. Returns zero if the edge intersects the cell interior.

  Parameters

  • a: s2.Point
  • b: s2.Point

  Returns number

edge

• edge(k: number): s2.Point

  Returns the inward-facing normal of the great circle passing through the CCW ordered edge from vertex k to vertex k+1 (mod 4) (for k = 0,1,2,3).

  Parameters

  • k: number

  Returns s2.Point

exactArea

• exactArea(): number

  Returns the area of this cell as accurately as possible.

  Returns number

intersectsCell

• intersectsCell(oc: Cell): boolean

  Reports whether the intersection of this cell and the other cell is not nil.

  Parameters

  • oc: Cell

  Returns boolean

isLeaf

• isLeaf(): boolean

  Returns whether this Cell is a leaf or not.

  Returns boolean

latitude

• latitude(i: number, j: number): number

  Returns the latitude of the cell vertex in radians given by (i,j), where i and j indicate the Hi (1) or Lo (0) corner.

  Parameters

  • i: number
  • j: number

  Returns number

longitude

• longitude(i: number, j: number): number

  Returns the longitude of the cell vertex in radians given by (i,j), where i and j indicate the Hi (1) or Lo (0) corner.

  Parameters

  • i: number
  • j: number

  Returns number

maxDistance

• maxDistance(target: s2.Point): number

  Reports the maximum distance from the cell (including its interior) to the given point.

  Parameters

  • target: s2.Point

  Returns number

maxDistanceToCell

• maxDistanceToCell(target: Cell): number

  Returns the maximum distance from the cell (including its interior) to the given target cell.

  Parameters

  • target: Cell

  Returns number

maxDistanceToEdge

• maxDistanceToEdge(a: s2.Point, b: s2.Point): number

  Returns the maximum distance from the cell (including its interior) to the given edge AB.

  Parameters

  • a: s2.Point
  • b: s2.Point

  Returns number

rectBound

• rectBound(): s2.Rect

  Returns the bounding rectangle of this cell.

  Returns s2.Rect

sizeIJ

• sizeIJ(): number

  Returns the edge length of this cell in (i,j)-space.

  Returns number

sizeST

• sizeST(): number

  Returns the edge length of this cell in (s,t)-space.

  Returns number

uEdgeIsClosest

• uEdgeIsClosest(p: s2.Point, vHi: boolean): boolean

  Reports whether a point P is closer to the interior of the specified Cell edge (either the lower or upper edge of the Cell) or to the endpoints.

  Parameters

  • p: s2.Point
  • vHi: boolean

  Returns boolean

vEdgeIsClosest

• vEdgeIsClosest(p: s2.Point, uHi: boolean): boolean

  Reports whether a point P is closer to the interior of the specified Cell edge (either the right or left edge of the Cell) or to the endpoints.

  Parameters

  • p: s2.Point
  • uHi: boolean

  Returns boolean

vertex

• vertex(k: number): s2.Point

  Returns the k-th vertex of the cell (k = 0,1,2,3) in CCW order (lower left, lower right, upper right, upper left in the UV plane).

  Parameters

  • k: number

  Returns s2.Point

vertexChordDist2

• vertexChordDist2(p: s2.Point, xHi: boolean, yHi: boolean): number

  Returns the squared chord distance from point P to the given corner vertex specified by the Hi or Lo values of each.

  Parameters

  • p: s2.Point
  • xHi: boolean
  • yHi: boolean

  Returns number

StaticedgeDistance

• edgeDistance(ij: number, uv: number): number

  Reports the distance from a Point P to a given Cell edge. The point P is given by its dot product, and the uv edge by its normal in the given coordinate value.

  Parameters

  • ij: number
  • uv: number

  Returns number

StaticoppositeFace

• oppositeFace(face: number): number

  Returns the face opposite the given face.

  Parameters

  • face: number

  Returns number