Interface MapModule

Module for providing Map utils.

interface MapModule {
    name: string;
    uniqueIdentifier: string;
    createMapTextureProvider(): Texture;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
    longLatToImageRatio(longitude: number, latitude: number, location: LocationAsset): vec2;
}

Hierarchy (view full)

Properties

name uniqueIdentifier

Methods

createMapTextureProvider getTypeName isOfType isSame longLatToImageRatio

Properties

name

name: string

The name of the Asset in Lens Studio.

ReadonlyuniqueIdentifier

uniqueIdentifier: string

Methods

createMapTextureProvider

  • createMapTextureProvider(): Texture

  • Creates a new texture which holds a MapTextureProvider.

    Returns Texture

getTypeName

  • getTypeName(): string

  • Returns the name of this object's type.

    Returns string

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

longLatToImageRatio

  • longLatToImageRatio(longitude, latitude, location): vec2

  • Returns the position of the marker (relative to the associated map tile) based on the specified longitude, latitude and location. The top left corner of the provided location has a value of [0,0] and the right down corner has a value of [1.1].

    Parameters

    Returns vec2

Settings

Member Visibility

On This Page

Properties
Methods