Documentation of a layer-based system

[MathiasBaumgartinger]

As mentioned in #235, we will restructure the the whole node-tree. In more detail, the new structure should have a layer-based system. A LayerContainer which will handle every additional geo-information. This can for instance be raster-data, such as vegetation (grass, trees, ...) but also vector-data, such as assets (existing wind-turbines).

Layers should also be able to be grouped (sublayers), for example there will be different street sublayers grouped in one street-layer. Layers will be instanced by a WorldConfigurator according to information from the configuration node (at issue #230). A layer's sole purpose will be display of geodata. It will access the geodata via a global distributor of geodata.

A general idea was to have super-class Layer and then distinguish between an ObjectLayer and an AreaLayer.

[MathiasBaumgartinger]

Further discussed resulted in following structure:

• World
  • WorldConfigurator : Configurator
  • BaseTiles
    • Modules
      • Collider <-> Layer1
      • HeightmapTerrain <-> Layer1, Layer2
  • LayerRenderers : Configurator
    • Layer3Renderer <-> Layer3
• UI
  • UIConfigurator
  • ...
    • LayerListUI
      • Layer1UIView <-> Layer1
• Layers
  • LayerConfigurator
  • Layer1
  • Layer2
  • Layer3
  • ...
• Game Engine
  • ...
    • ScoreXY -> Layer1, Layer2

This will also be relevant for #237 and #235.

[MathiasBaumgartinger]

Classes are described as follows (in German):

Configurator (Superclass):

• Allgemein definierte Schnittstelle zum Zugreifen auf verschiedenste Informationen von Configuration (Geopackages/Settings)
• Kann modular für jede Stelle in Godot, die vom Geopackage abhängig ist, implementiert und angehängt werden
• Related to Add a WorldConfigurator, UIConfigurator and possibly a (VR)PlayerConfigurator #237

Layers (Singleton):

• Bietet Zugriff auf die einzelnen Layer Controller von überall
• Bietet verschiedene Signale für jeweilige andere Configurationsstellen

LayerConfigurator:

• Ladet ein Layer für jedes GeoLayer im GeoDataset beim Startup
• Weißt die Richtung Attribute/Modelle/etc. zu

Layer:

• Implementation ist zuständig für das Caching, kann beliebige eigene Logik schreiben: z.b. wenn verbunden mit mehreren Views und nicht positionsspezifischer Datensatz -> cachen, ansonsten nicht (wenn kein caching nötig ist kanns auch ganz weggelassen werden)
• Hat ein GeoLayer
• Bietet Daten aus GeoLayer in LandscapeLab-spezifischer Form und kümmert sich um etwaige Logik (z.b. ob Platzierung erlaubt ist)

GeoLayer:

• Bietet Daten aus Geodatensätzen in Godot-spezifischer Form (über GDAL)

LayerRenderers : Configurator:

• Eine Art Container, die sich um die erstmalige Instanzierung aller Layer kümmert (Configurator)
• Reagiert auf verschiedene Signale, wie beispielsweise new RenderedLayer

LayerRenderer:

• Kümmert sich um die graphische Darstellung innerhalb der Welt
• Ist nach der ersten Instanzierung direkt mit dem Layer verbunden und reagiert auf dessen Änderungen, etc.

LayerUI : Configurator:

• Eine Art Container, die sich um die erstmalige Instanzierung aller Layer kümmert (Configurator)
• Reagiert auf verschiedene Signale, wie beispielsweise new UILayer
• Kann bestehende Layer innerhalb der UI des Spiels bearbeiten, löschen, manipulieren
• Kann neue Layer erstellen

[MathiasBaumgartinger]

For a deeper understanding we have defined three "user-stories":

Scenario 1: Instance Layers on Startup

Scenario 2: Adding a 3D wind turbine object

Scenario 3: Creating a new raster layer through the U

[MathiasBaumgartinger]

d693969 provided a basic implementation for most of these classes.

[kb173]

We should move these descriptions and images to the wiki.

[kb173]

Same as #248: rather than the Wiki, we'll use Markdown documents within the project source for this.