Struct PickHit 

pub struct PickHit {

    pub category: HitCategory,
    pub provenance: HitProvenance,
    pub layer_id: Option<String>,
    pub source_id: Option<String>,
    pub source_layer: Option<String>,
    pub source_tile: Option<TileId>,
    pub feature_id: Option<String>,
    pub feature_index: Option<usize>,
    pub geometry: Option<Geometry>,
    pub properties: HashMap<String, PropertyValue>,
    pub state: FeatureState,
    pub distance_meters: f64,
    pub hit_coord: Option<GeoCoord>,
    pub layer_priority: u32,
    pub from_symbol: bool,
}

A single hit from a pick operation.

This is the canonical result type consumed by host applications. It provides identity, geometry, properties, state, distance, provenance, and category metadata for every hit.

Fields

category: HitCategory

Broad category of this hit.

provenance: HitProvenance

How this hit was resolved.

layer_id: Option<String>

Style layer id or runtime layer name that produced the hit.

source_id: Option<String>

Style source id, when known.

source_layer: Option<String>

Style source-layer id, when known.

source_tile: Option<TileId>

Tile that supplied the feature, when known.

feature_id: Option<String>

Stable feature id within the source.

feature_index: Option<usize>

Source-local feature index.

geometry: Option<Geometry>

Feature geometry, when available.

properties: HashMap<String, PropertyValue>

Feature properties, when available.

state: FeatureState

Mutable feature-state snapshot at query time.

distance_meters: f64

Distance from the query position in meters.

hit_coord: Option<GeoCoord>

Geographic coordinate of the hit point.

layer_priority: u32

Layer-order priority (lower = rendered on top / higher priority).

This is derived from the reverse layer-stack index so that top-most rendered layers have the lowest priority value.

from_symbol: bool

Whether the hit came from a placed symbol collision box.

Implementations

impl PickHit

pub fn terrain_surface(coord: GeoCoord, elevation: Option<f64>) -> Self

Create a terrain-surface hit.

Trait Implementations

impl Clone for PickHit

fn clone(&self) -> PickHit

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PickHit

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.