Class EdgeQueryShapeIndexTarget

constructor

• new EdgeQueryShapeIndexTarget(index: ShapeIndex): EdgeQueryShapeIndexTarget

  Parameters

  • index: ShapeIndex

  Returns EdgeQueryShapeIndexTarget

Readonlyindex

getCapBound

• getCapBound(): { center: s2.Point; radius: number } | null

  Returns a cap that bounds the target geometry.

  Returns { center: s2.Point; radius: number } | null

includeInteriors

• includeInteriors(): boolean

  Returns true if the target includes the interior of polygons.

  Returns boolean

maxBruteForceIndexSize

• maxBruteForceIndexSize(): number

  Returns the maximum number of edges in the index for which it is faster to use brute force search rather than the hierarchical method.

  Returns number

setIncludeInteriors

• setIncludeInteriors(includeInteriors: boolean): void

  Sets whether to include polygon interiors when measuring distances.

  Parameters

  • includeInteriors: boolean

  Returns void

setMaxError

• setMaxError(_maxError: number): boolean

  Sets the max error for distance calculations. Returns true if the target uses this error for optimization.

  Parameters

  • _maxError: number

  Returns boolean

updateMinDistanceToCell

• updateMinDistanceToCell(
      cell: Cell,
      minDist: number,
  ): { distance: number; updated: boolean }

  Updates minDist if the distance to the cell is less than minDist. Returns true if the distance was updated.

  Parameters

  • cell: Cell
  • minDist: number

  Returns { distance: number; updated: boolean }

updateMinDistanceToEdge

• updateMinDistanceToEdge(
      v0: s2.Point,
      v1: s2.Point,
      minDist: number,
  ): { distance: number; updated: boolean }

  Updates minDist if the distance to the edge (v0, v1) is less than minDist. Returns true if the distance was updated.

  Parameters

  • v0: s2.Point
  • v1: s2.Point
  • minDist: number

  Returns { distance: number; updated: boolean }

updateMinDistanceToPoint

• updateMinDistanceToPoint(
      point: s2.Point,
      minDist: number,
  ): { distance: number; updated: boolean }

  Updates minDist if the distance to the point is less than minDist. Returns true if the distance was updated.

  Parameters

  • point: s2.Point
  • minDist: number

  Returns { distance: number; updated: boolean }

visitContainingShapeIds

• visitContainingShapeIds(
      index: ShapeIndex,
      visitor: (shapeID: number, point: s2.Point) => boolean,
  ): boolean

  Visits shape IDs in the index that contain the target. Used for include_interiors support.

  Parameters

  • index: ShapeIndex
  • visitor: (shapeID: number, point: s2.Point) => boolean

  Returns boolean