Class MappingSession

Example

// Have a frame of reference to where
// tracking starting in the session
// LocationAsset returns a label for the co-ordinate frame
var worldOriginLocationAsset = LocationAsset.getAROrigin();

worldOriginLocatedAt = global.scene.createSceneObject("AR Origin").createComponent("LocatedAtComponent");

// LocatedAtComponent
worldOriginLocatedAt.location = worldOriginLocationAsset;

// MAP NEW LOCATION + GET STORE FOR IT

// Start mapping the space of the user
var options = LocatedAtComponent.createMappingOptions();
options.locationCloudStorageModule = locationCloudStorageModule;
options.location = worldOriginLocationAsset;

mappingSession = LocatedAtComponent.createMappingSession(options);

mappingSession.onMapped.add((location) => {
   // we _can_ use location if we like - it is now a persisted private custom
   // location and has the same coordinate frame as worldOriginLocationAsset
   currentLocationLocatedAt.location = location;

   locationCloudStorageModule.storeLocation(
       location,
       (locationId) => {
          // cloud storage is not associated with locations but can store strings
          // locationCloudStorageModule has privacy model for location <-> string.
          cloudStorage.putString("previous-location",
                                 locationId);
      },
      (errorString) => {
          print("failed to obtain persistent id for location: " + errorString);
      });
      
      
    var options = LocationCloudStorageOptions.create();
    options.location = location;
    options.onDiscoveredNearby.add((store) => {
        //store code here
    });
 
    options.onError.add((error) => {
        //error code here
    });
    
    // get store and use it
    locationCloudStorageModule.getNearbyLocationStores(options);
       
   ...

   // Mapping will continue; can be cancelled or throttled here
});


...

// Progress towards map being of acceptable quality (ie canCheckpoint going true)
print(mappingSession.quality);           // 0 -> 1
print(mappingSession.canCheckpoint);     // == (quality >= 1)

// force onMapped to be fired immediately
// can be called 'early' once canCheckpoint goes true
mappingSession.checkpoint();             // error to call with
                                         // canCheckpoint == false

print(mappingSession.capacityUsed);      // 0 -> 1
                                         // when ==1 onMapped is fired
                                         // quality guaranteed >=1 at
                                         // that point

...

mappingSession.setThrottling(MappingSession.Auto);
//                or    (MappingSession.MappingThrottling.Foreground)
//                or    (MappingSession.MappingThrottling.Background)
//                or    (MappingSession.MappingThrottling.Off)

... or
mappingSession.cancel();

...

// concurrently with creating a new map

function onPreviousLocationRetrieved(previousLocationAsset) {
    // TRACKING PREVIOUS + GETTING STORES FOR PREVIOUS
    previousLocationLocatedAt.location = previousLocationAsset;
    previousLocationLocatedAt.onFound.add(() => {
        // Cancel new location mapping
        mappingSession.cancel();
      
        // we could switch to incremental by creating a new mapping session here
        // using previousLocationAsset
      
        ...
     
        var options = LocationCloudStorageOptions.create();
        options.location = previousLocationAsset;
        options.onDiscoveredNearby.add((store) => {
            //store code here
        });
 
        options.onError.add((error) => {
            //error code here
        });
    
        // get a store for the tracked location
        locationCloudStorageModule.getNearbyLocationStores(options);
    });
};

function onError(errorString) {
    print("could not retrieve previous location: " + errorString);
};

// use some other means of storage to retrieve a previously stored location id
var previousLocationId = cloudStorage.getString("previous-location");

locationCloudStorageModule.retrieveLocation(
                                previousLocationId,
                                onPreviousLocationRetrieved,
                                onError);
Copy