InterfaceMappingOptions

Used with MappingSession to describe the session to be created.

interface MappingOptions {
    location: LocationAsset;
    locationCloudStorageModule: LocationCloudStorageModule;
    policy: string;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
}

Hierarchy (view full)

Properties

location locationCloudStorageModule policy

Methods

getTypeName isOfType isSame

Properties

location

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: 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

policy: string

Use case for mapping. Default "auto".

Methods

getTypeName

isOfType

  • isOfType(type): boolean

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

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other): 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

Settings

Member Visibility

On This Page

Properties
Methods