Skip to main content

Location & Navigation

GPS, compass, maps, city-scale and custom locations, and geo-anchored content.

Commonly used

Guides

All APIs in this topic

Add components to a scene object, reference assets and other modules with a script input, and require modules with require('LensStudio:<name>').

Components, assets, and modules

APIDescription
AnchorLocationModule SPECSLook up the real-world geographic position of an anchor.
CustomLocationGroupComponentA component managing and tracking a group of Custom Locations with known relative transforms.
DeviceLocationTrackingComponentUsed to track a real-world location in a Lens.
LocatedAtComponentEnables placing a SceneObject at a real world location provided by LocationAsset and specified relative position.
LocationAssetProvides a frame of reference in which to localize objects to the real world.
MapModuleAllows access to map texture data around a specified location.
ProcessedLocationModuleDeclares the precise location tracking permission for your Lens project.
RawLocationModuleDeclares the coarse location tracking permission for your Lens project.

Objects and data

APIDescription
AnchorAn object containing the position of an object relative to a LocationAsset.
CompassTrackingData
GeoLocation
GeoPositionThe location of the device.
LocationRenderObjectProviderProvides access to a location's Mesh--such as when working with City Scale AR.
LocationServiceThe LocationService allows the user to provide their location to Lens applications if they so desire.
LocationTextureProviderProvides access to a location's texture--such as when working with City Scale AR.
MappingOptionsUsed with MappingSession to describe the session to be created.
MappingSessionUsed with the LocatedAtComponent to map the current physical location.
MapTextureProviderA texture of the map at the given location of a LocationAsset.

Enums

APIDescription
GeoLocationAccuracyEnumeration of supported GPS location accuracy.
LocationProximityStatusUsed by DeviceLocationTrackingComponent to indicate the user's distance from the landmarker location.