Class MapModule

Allows access to map texture data around a specified location.

See

Map Component guide.

Hierarchy (View Summary, Expand)

Asset
- MapModule

Index

Constructors

Properties

name uniqueIdentifier

Methods

createMapTextureProvider getTypeName isOfType isSame longLatToImageRatio

Constructors

`Protected`constructor

new MapModule(): MapModule
Returns MapModule
Overrides Asset.constructor

Properties

name

name: string

The name of the Asset in Lens Studio.

`Readonly`uniqueIdentifier

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
Inherited from Asset.getTypeName

isOfType

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

isSame

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

longLatToImageRatio

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