Interface MapModule

Description

Module for providing Map utils.

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

Hierarchy (view full)

Asset
- MapModule

Index

Properties

name uniqueIdentifier

Methods

createMapTextureProvider getTypeName isOfType isSame longLatToImageRatio

Properties

name

name: string

Description

The name of the Asset in Lens Studio.

`Readonly` uniqueIdentifier

uniqueIdentifier: string

Methods

createMapTextureProvider

createMapTextureProvider(): Texture
Returns Texture
Description
Creates a new texture which holds a MapTextureProvider.

getTypeName

getTypeName(): string
Returns string
Description
Returns the name of this object's type.

Inherited from Asset.getTypeName

isOfType

isOfType(type): boolean
Parameters
- type: string
Returns boolean
Description
Returns true if the object matches or derives from the passed in type.

Inherited from Asset.isOfType

isSame

isSame(other): boolean
Parameters
- other: ScriptObject
Returns boolean
Description
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

Inherited from Asset.isSame

longLatToImageRatio

longLatToImageRatio(longitude, latitude, location): vec2
Parameters
- longitude: number
- latitude: number
- location: LocationAsset
Returns vec2
Description
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].

Generated using TypeDoc