Lens Scripting API
    Preparing search index...

    Class MappingOptions

    Used with MappingSession to describe the session to be created.

    Hierarchy (View Summary)

    Index

    Properties

    geoPositionEnabled: boolean

    Toggles the acquisition of geolocation metadata during a mapping session.

    location: LocationAsset

    Location hint for mapping. Leave unset or use LocationAsset.getAROrigin() for mapping in the current AR session frame. (planned future extension) Use a pre-existing location for incremental mapping.

    locationCloudStorageModule: LocationCloudStorageModule

    Must be present to provide a sharing model for the location. Map storage is private to the user, or shared via ConnectedLensSession on the the module (Spectacles only).

    policy: string

    Use case for mapping. Default "auto".

    If All, the checkpoint will contain all seen and tracked areas. If New, it will only contain areas seen and tracked after the MappingSession was constructed. The option is used to define which parts of the map should be included in a checkpoint. For small maps, including only the data visible at an instance, use New. For complete maps encompassing all visited areas, use All.

    Default: All

    Methods

    • Returns true if the object matches or derives from the passed in type.

      Parameters

      • type: string

      Returns boolean

    • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

      Parameters

      Returns boolean