Import
======

This document describes how to get spatial data into a PlexMap installation.
The basic import workflow is to create and configure a Depot, and then call
``loadgeometries``. So the Depot is configured once and can be updated easily
whenever the data changes.

The following formats can be used:

SketchUp/KMZ
------------

Set **Loadtype** to **3D-Meshes** and **Format** to **KMZ**. See :doc:`user_guide_import_kmz`.

STL
---

Set **Loadtype** to **3D-Meshes** and **Format** to **STL**.

=============== =========================================================
Attribute       Description
=============== =========================================================
``offset``      Coord triplet to add to all coordinates (optional)
``prefix``      String to prefix IDs (optional)
=============== =========================================================

Wavefront .Obj
--------------

Set **Loadtype** to **3D-Meshes** and **Format** to **Wavefront .Obj**.

=============== =========================================================
Attribute       Description
=============== =========================================================
``up_axis``     The upwards pointing axis (default: ``z``)
``offset``      Coord triplet to add to all coordinates (optional)
``prefix``      String to prefix IDs (optional)
=============== =========================================================

ESRI Shapefile
--------------

Set **Loadtype** to **2D-Features** and **Format** to **ESRI Shapefile**.

OpenStreetMap
-------------

Set **Loadtype** to **2D-Features** and **Format** to **Overpass API**. The
**Projection** must be set to **4326**. The following format arguments can be
used:

=============== =========================================================
Attribute       Description
=============== =========================================================
``query``       The Overpass API query, for example: ``(node["highway"="bus_stop"]({{bbox}}))``
=============== =========================================================

CityGML
-------

Set **Loadtype** to **3D-Meshes**. The following format arguments can be used:

=============== =========================================================
Attribute       Description
=============== =========================================================
``obj_type``    Type of CityGML data to import. Possible values:
                 * ``buildings`` (default)
                 * ``buildingparts``
                 * ``generics``
                 * ``furniture``
                 * ``vegetation``
                 * ``terrain``
                 * ``bridges`` (requires at least CityGML 2.0)
                 * ``all``
``offset``      Coord triplet to add to all coordinates (optional)
``prefix``      String to prefix IDs (optional)
=============== =========================================================

For details, see: :doc:`user_guide_import`.

WFS
---

The WFS format will import data from a remote WFS service. Set **Loadtype** to
**2D-Features** and enter the URL of the WFS service into the **Input URIs**
field. The following format arguments can be used:

=============== =========================================================
Attribute       Description
=============== =========================================================
``type_name``   ``typeName`` used in the WFS query (mandatory)
``version``     WFS version (default: 2.0.0)
``use_bounds``  If this is ``true``, limit WFS query to config bbox
                (default ``false``)
=============== =========================================================

WMS
---

The WMS format will import data from a remote WMS service. Set **Loadtype** to
**WMS** and enter the URL of the WFS service into the **Input URIs** field.
The following format arguments can be used:

=============== =========================================================
Attribute       Description
=============== =========================================================
``layers``      ``layers`` used in the WMS query (mandatory)
``version``     WMS version (default: 1.1.0)
``use_bounds``  If this is ``true``, limit WFS query to config bbox
                (default ``false``)
=============== =========================================================

For details, see: :doc:`user_guide_wms`.

WMTS
----

The WMTS format will import data from a remote WMS service. Set **Loadtype** to
**WMTS** and enter the URL of the WFS service into the **Input URIs** field.
The following format arguments can be used:

=============== =========================================================
Attribute       Description
=============== =========================================================
``layers``      ``layers`` used in the WMS query (mandatory)
``version``     WMTS version (default: 1.0.0)
``tileset``     The *MatrixTileSet* in the WMTS URL
=============== =========================================================

Analog zum WMS gibt es auch für den WMTS einen ``addwmts``-Befehl, um den
Import zu vereinfachen.