Location & Navigation
GPS, compass, maps, city-scale and custom locations, and geo-anchored content.
Commonly used
RawLocationModuleDeclares the coarse location tracking permission for your Lens project.LocationServiceThe LocationService allows the user to provide their location to Lens applications if they so desire.LocatedAtComponentEnables placing a SceneObject at a real world location provided by LocationAsset and specified relative position.DeviceLocationTrackingComponentUsed to track a real-world location in a Lens.LocationAssetProvides a frame of reference in which to localize objects to the real world.MapModuleAllows access to map texture data around a specified location.
Guides
LocationRead GPS coordinates and compass heading on SPECS with the Location API to build location-aware Lenses.Spatial Persistence TemplateWith Spatial Persistence, users will be able to read or write AR content at a physical location and retrieve this data at the same physical location when they restart their lenses.Custom LocationsMap real-world areas with the Custom Locations Scanner Lens and import them into Lens Studio to create persistent location-based AR experiences.Components ListBrowse the Navigation Kit components, assets and APIs for SPECS Lenses: places, the user's position, the place menu and the navigation arrow.
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
| API | Description |
|---|---|
| AnchorLocationModule SPECS | Look up the real-world geographic position of an anchor. |
| CustomLocationGroupComponent | A component managing and tracking a group of Custom Locations with known relative transforms. |
| DeviceLocationTrackingComponent | Used to track a real-world location in a Lens. |
| LocatedAtComponent | Enables placing a SceneObject at a real world location provided by LocationAsset and specified relative position. |
| LocationAsset | Provides a frame of reference in which to localize objects to the real world. |
| MapModule | Allows access to map texture data around a specified location. |
| ProcessedLocationModule | Declares the precise location tracking permission for your Lens project. |
| RawLocationModule | Declares the coarse location tracking permission for your Lens project. |
Objects and data
| API | Description |
|---|---|
| Anchor | An object containing the position of an object relative to a LocationAsset. |
| CompassTrackingData | |
| GeoLocation | |
| GeoPosition | The location of the device. |
| LocationRenderObjectProvider | Provides access to a location's Mesh--such as when working with City Scale AR. |
| LocationService | The LocationService allows the user to provide their location to Lens applications if they so desire. |
| LocationTextureProvider | Provides access to a location's texture--such as when working with City Scale AR. |
| MappingOptions | Used with MappingSession to describe the session to be created. |
| MappingSession | Used with the LocatedAtComponent to map the current physical location. |
| MapTextureProvider | A texture of the map at the given location of a LocationAsset. |
Enums
| API | Description |
|---|---|
| GeoLocationAccuracy | Enumeration of supported GPS location accuracy. |
| LocationProximityStatus | Used by DeviceLocationTrackingComponent to indicate the user's distance from the landmarker location. |
Related topics
Cloud, Networking & Storage › StorageData kept on the device between sessions, and cloud storage shared across users or locations.Graphics, Materials & Particles › Textures & VideoTexture assets and providers, video playback and recording, and media pickers.Graphics, Materials & Particles › Meshes & EffectsMesh visuals and mesh building, VFX, post effects, and Gaussian splats.