Class CollisionIndex

constructor

• new CollisionIndex(
      transform: IReadonlyTransform,
      grid?: GridIndex<FeatureKey>,
      ignoredGrid?: GridIndex<FeatureKey>,
  ): CollisionIndex

  Parameters

  • transform: IReadonlyTransform
  • Optionalgrid: GridIndex<FeatureKey>
  • OptionalignoredGrid: GridIndex<FeatureKey>

  Returns CollisionIndex

grid

gridBottomBoundary

gridRightBoundary

ignoredGrid

perspectiveRatioCutoff

pitchFactor

screenBottomBoundary

screenRightBoundary

transform

getPerspectiveRatio

• getPerspectiveRatio(
      x: number,
      y: number,
      unwrappedTileID: UnwrappedTileID,
      getElevation?: (x: number, y: number) => number,
  ): number

  Parameters

  • x: number
  • y: number
  • unwrappedTileID: UnwrappedTileID
  • OptionalgetElevation: (x: number, y: number) => number

  Returns number

getViewportMatrix

• getViewportMatrix(): mat4

  Returns mat4

insertCollisionBox

• insertCollisionBox(
      collisionBox: number[],
      overlapMode: OverlapMode,
      ignorePlacement: boolean,
      bucketInstanceId: number,
      featureIndex: number,
      collisionGroupID: number,
  ): void

  Parameters

  • collisionBox: number[]
  • overlapMode: OverlapMode
  • ignorePlacement: boolean
  • bucketInstanceId: number
  • featureIndex: number
  • collisionGroupID: number

  Returns void

insertCollisionCircles

• insertCollisionCircles(
      collisionCircles: number[],
      overlapMode: OverlapMode,
      ignorePlacement: boolean,
      bucketInstanceId: number,
      featureIndex: number,
      collisionGroupID: number,
  ): void

  Parameters

  • collisionCircles: number[]
  • overlapMode: OverlapMode
  • ignorePlacement: boolean
  • bucketInstanceId: number
  • featureIndex: number
  • collisionGroupID: number

  Returns void

isInsideGrid

• isInsideGrid(x1: number, y1: number, x2: number, y2: number): boolean

  Parameters

  • x1: number
  • y1: number
  • x2: number
  • y2: number

  Returns boolean

isOffscreen

• isOffscreen(x1: number, y1: number, x2: number, y2: number): boolean

  Parameters

  • x1: number
  • y1: number
  • x2: number
  • y2: number

  Returns boolean

placeCollisionBox

• placeCollisionBox(
      collisionBox: SingleCollisionBox,
      overlapMode: OverlapMode,
      textPixelRatio: number,
      tileID: OverscaledTileID,
      unwrappedTileID: UnwrappedTileID,
      pitchWithMap: boolean,
      rotateWithMap: boolean,
      translation: [number, number],
      collisionGroupPredicate?: (key: FeatureKey) => boolean,
      getElevation?: (x: number, y: number) => number,
      shift?: Point,
      simpleProjectionMatrix?: mat4,
  ): PlacedBox

  Parameters

  • collisionBox: SingleCollisionBox
  • overlapMode: OverlapMode
  • textPixelRatio: number
  • tileID: OverscaledTileID
  • unwrappedTileID: UnwrappedTileID
  • pitchWithMap: boolean
  • rotateWithMap: boolean
  • translation: [number, number]
  • OptionalcollisionGroupPredicate: (key: FeatureKey) => boolean
  • OptionalgetElevation: (x: number, y: number) => number
  • Optionalshift: Point
  • OptionalsimpleProjectionMatrix: mat4

  Returns PlacedBox

placeCollisionCircles

• placeCollisionCircles(
      overlapMode: OverlapMode,
      symbol: PlacedSymbolStruct,
      lineVertexArray: SymbolLineVertexArray,
      glyphOffsetArray: GlyphOffsetArray,
      fontSize: number,
      unwrappedTileID: UnwrappedTileID,
      pitchedLabelPlaneMatrix: mat4,
      showCollisionCircles: boolean,
      pitchWithMap: boolean,
      collisionGroupPredicate: (key: FeatureKey) => boolean,
      circlePixelDiameter: number,
      textPixelPadding: number,
      translation: [number, number],
      getElevation: (x: number, y: number) => number,
  ): PlacedCircles

  Parameters

  • overlapMode: OverlapMode
  • symbol: PlacedSymbolStruct
  • lineVertexArray: SymbolLineVertexArray
  • glyphOffsetArray: GlyphOffsetArray
  • fontSize: number
  • unwrappedTileID: UnwrappedTileID
  • pitchedLabelPlaneMatrix: mat4
  • showCollisionCircles: boolean
  • pitchWithMap: boolean
  • collisionGroupPredicate: (key: FeatureKey) => boolean
  • circlePixelDiameter: number
  • textPixelPadding: number
  • translation: [number, number]
  • getElevation: (x: number, y: number) => number

  Returns PlacedCircles

projectAndGetPerspectiveRatio

• projectAndGetPerspectiveRatio(
      x: number,
      y: number,
      unwrappedTileID: UnwrappedTileID,
      getElevation?: (x: number, y: number) => number,
      simpleProjectionMatrix?: mat4,
  ): {
      isOccluded: boolean;
      perspectiveRatio: number;
      signedDistanceFromCamera: any;
      x: number;
      y: number;
  }

  Parameters

  • x: number
  • y: number
  • unwrappedTileID: UnwrappedTileID
  • OptionalgetElevation: (x: number, y: number) => number
  • OptionalsimpleProjectionMatrix: mat4

  Returns {
      isOccluded: boolean;
      perspectiveRatio: number;
      signedDistanceFromCamera: any;
      x: number;
      y: number;
  }

projectPathToScreenSpace

• projectPathToScreenSpace(
      projectedPath: Point[],
      projectionContext: SymbolProjectionContext,
  ): PointProjection[]

  Parameters

  • projectedPath: Point[]
  • projectionContext: SymbolProjectionContext

  Returns PointProjection[]

queryRenderedSymbols

• queryRenderedSymbols(viewportQueryGeometry: Point[]): {}

  Because the geometries in the CollisionIndex are an approximation of the shape of symbols on the map, we use the CollisionIndex to look up the symbol part of queryRenderedFeatures.

  Parameters

  • viewportQueryGeometry: Point[]

  Returns {}