Class MapView

Map viewer is used to read and display map tiles from a server.

It was designed to work with a OpenMapTiles but can also be used with another map tiles.

The map is drawn in plane map nodes using a quad tree that is subdivided as necessary to guaratee good map quality.

Hierarchy

  • Mesh
    • MapView

Constructors

constructor

Properties

cacheTiles heightProvider isClip? lod onBeforeRender options provider root scheduler useScheduler HEIGHT HEIGHT_SHADER MARTINI PLANAR mapModes

Methods

clear clip getMapBounds isWebBaseMap lngLatToLocal lngLatToNormalize lngLatToWorld localToLngLat localToMap mapToLocal mapToWorld maxZoom minZoom preSubdivide raycast setHeightProvider setProvider setRoot worldResolution worldToLngLat worldToMap

Constructors

constructor

  • new MapView(options): MapView

  • Constructor for the map view objects.

    Parameters

    • options: MapViewOption

    Returns MapView

Properties

cacheTiles

cacheTiles: boolean = false

Indicate if the nodes should cache its children when it is simplified. Nodes that are no longer in use should be kept in memory.

Usefull for fast moving scenarios to prevent reparsing data in fast moving scenes.

Should only be used if the child generation process is time consuming. Should be kept off unless required.

heightProvider

heightProvider: MapProvider = null

Map height (terrain elevation) layer provider.

Only used for HEIGHT, HEIGHT_SHADER and MARTINI map modes.

Optional isClip

isClip?: boolean

lod

lod: LODControl = null

LOD control object used to defined how tiles are loaded in and out of memory.

onBeforeRender

onBeforeRender: ((renderer, scene, camera, geometry, material, group) => void) = ...

Ajust node configuration depending on the camera distance.

Called everytime automatically before render by the renderer.

Type declaration

    • (renderer, scene, camera, geometry, material, group): void

    • Ajust node configuration depending on the camera distance.

      Called everytime automatically before render by the renderer.

      Parameters

      • renderer: WebGLRenderer
      • scene: Scene
      • camera: Camera
      • geometry: BufferGeometry<NormalBufferAttributes>
      • material: Material
      • group: Group<Object3DEventMap>

      Returns void

options

options: MapViewOption

provider

provider: MapProvider = null

Map tile color layer provider.

root

root: MapNode = null

Define the type of map node in use, defined how the map is presented.

Should only be set on creation.

scheduler

scheduler: Scheduler

useScheduler

useScheduler: boolean = true

Static HEIGHT

HEIGHT: number = 202

Planar map projection with height deformation.

Static HEIGHT_SHADER

HEIGHT_SHADER: number = 203

Planar map projection with height deformation using the GPU for height generation.

Static MARTINI

MARTINI: number = 204

RTIN map mode.

Static PLANAR

PLANAR: number = 200

Planar map projection.

Static mapModes

mapModes: Map<number, any> = ...

Map of the map node types available.

Methods

clear

  • clear(): any

  • Clears all tiles from memory and reloads data. Used when changing the provider.

    Should be called manually if any changed to the provider are made without setting the provider.

    Returns any

clip

  • clip(): void

  • Returns void

getMapBounds

  • getMapBounds(): [number, number, number, number]

  • Returns [number, number, number, number]

isWebBaseMap

  • isWebBaseMap(): boolean

  • 是否为互联网地图底图 (选项中设置了mapBounds的为cad底图，没设置mapBounds的为互联网底图)

    Returns boolean

lngLatToLocal

  • lngLatToLocal(lngLat): Vector3

  • 经纬度转局部世界坐标

    Parameters

    • lngLat: [number, number]

    Returns Vector3

lngLatToNormalize

  • lngLatToNormalize(lngLat): [number, number]

  • 经纬度转归一化的坐标, 先会把经纬度转墨卡托，然后根据最开始的[瓦片缩级别，行，列]rootTile的范围，归一化到0-1范围区间

    Parameters

    • lngLat: [number, number]

    Returns [number, number]

lngLatToWorld

  • lngLatToWorld(lngLat): Vector3

  • 经纬度转世界坐标

    Parameters

    • lngLat: [number, number]

    Returns Vector3

localToLngLat

  • localToLngLat(world): [number, number]

  • 局部世界坐标转经纬度

    Parameters

    • world: [number, number, number] | Vector3 | [number, number]

    Returns [number, number]

localToMap

  • localToMap(world): [number, number]

  • 局部世界坐标转地图坐标

    Parameters

    • world: [number, number, number] | Vector3 | [number, number]

    Returns [number, number]

mapToLocal

  • mapToLocal(point): Vector3

  • 地图坐标转局部世界坐标

    Parameters

    • point: [number, number]

    Returns Vector3

mapToWorld

  • mapToWorld(lngLat): Vector3

  • 地图坐标转世界坐标

    Parameters

    • lngLat: [number, number]

    Returns Vector3

maxZoom

  • maxZoom(): number

  • Get the maximum zoom level available in the providers attached to the map view.

    Returns number

    Maximum zoom level available.

minZoom

  • minZoom(): number

  • Get the minimum zoom level available in the providers attached to the map view.

    Returns number

    Minimum zoom level available.

preSubdivide

  • preSubdivide(): void

  • Pre-subdivide map tree to create nodes of levels not available in the provider.

    Checks for the minimum zoom level in the providers attached to the map view.

    Returns void

raycast

  • raycast(raycaster, intersects): boolean

  • Parameters

    • raycaster: Raycaster
    • intersects: any[]

    Returns boolean

setHeightProvider

  • setHeightProvider(heightProvider): void

  • Change the map height provider of this map view.

    Will discard all the tiles already loaded using the old provider.

    Parameters

    Returns void

setProvider

  • setProvider(provider): void

  • Change the map provider of this map view.

    Will discard all the tiles already loaded using the old provider.

    Parameters

    Returns void

setRoot

  • setRoot(root): void

  • Set the root of the map view.

    Is set by the constructor by default, can be changed in runtime.

    Parameters

    • root: number | MapNode

      Map node to be used as root.

    Returns void

worldResolution

  • worldResolution(): number

  • Returns number

worldToLngLat

  • worldToLngLat(world): [number, number]

  • 世界坐标转经纬度

    Parameters

    • world: [number, number, number] | Vector3 | [number, number]

    Returns [number, number]

worldToMap

  • worldToMap(world): [number, number]

  • 世界坐标转地图坐标

    Parameters

    • world: [number, number, number] | Vector3 | [number, number]

    Returns [number, number]

Settings

Member Visibility

Theme

On This Page