Skip to main content
Version: 3.8

struct CoverageArea

(Niantic.Lightship.AR.VpsCoverage.CoverageArea)

Overview

The CoverageArea struct represents an area where localization with VPS is possible. Precisely, it is a calculated area representing a cluster of localization targets within a certain proximity of each other to help determine reliability of VPS tracking.

struct CoverageArea {

enumLocalizability;

// fields

readonly string[] LocalizationTargetIdentifiers => _localizationTargetIdentifiers;
readonly LatLng[] Shape => _shape;
readonly Localizability LocalizabilityQuality => _localizabilityQuality;

// properties

LatLng Centroid;
};

Detailed Documentation

The CoverageArea struct represents an area where localization with VPS is possible. Precisely, it is a calculated area representing a cluster of localization targets within a certain proximity of each other to help determine reliability of VPS tracking.

Fields

LocalizationTargetIdentifiers

readonly string[] LocalizationTargetIdentifiers => _localizationTargetIdentifiers

Identifiers of all LocalizationTargets within the CoverageArea.

Shape

readonly LatLng[] Shape => _shape

Polygon outlining the CoverageArea.

LocalizabilityQuality

readonly Localizability LocalizabilityQuality => _localizabilityQuality

The localizability quality gives information about the chances of a successful localization in this CoverageArea.

Properties

Centroid

LatLng Centroid

Centroid of the Shape polygon.