Overlay: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
 
(391 intermediate revisions by 16 users not shown)
Line 1: Line 1:
{{learned|what an overlay is.|how overlays are implemented in the Tygron Engine.|which overlays exist.|how to use overlays.}}
[[File:Api_current_situation_calculation.png|thumb|right|400px|[[Overlay]] in comparison to [[Measurement]]s, [[Indicator]]s and [[Global]]s]]
==Overlays==
An overlay is a layer visualized on top of the [[terrain]] and [[building]]s in the 3D visualization. Overlays can provide spatial insight into specific subject, such as the variation of height and ownership. The visualized properties can originate from the current state of the project or from a result of a spatial calculation.  
An overlay is a layer drawn over a visualization to illustrate different properties. They do not contain all the information of a given visualization, but serve as a supplement to a base. By adding these properties onto the same view, the additional information can immediately be made understandable in the same way. A reason to split information off into other layers in this fashion can be to avoid overwhelming a user with too much information.


==How overlays are implemented in the Tygron Engine==
However, most overlays that can be added to a project use an underlying calculation model, which rasterize the spatial data and apply calculations to it to produce various (intermediate) results. These computational overlays can range from simple distance and average operations to complex water simulations. For these more complex Overlays with multiple results, additional [[Result Child Overlay]]s can be added. The calculation main and child results will always be governed by the main overlay, also called the [[Result Parent Overlay]].
Overlays are implemented in the Tygron Engine as part of the [[interface]]. Properties such as [[ownership]] and [[zoning]] are important pieces of information to the [[player]], but would be very overwhelming to display at all times. Instead, a player can activate on overlay to make these pieces of information visible. In principle, all spatially varied information is accessible as an overlay.


==Overlay types==
{{clear}}
Multiple types of overlay exist in the game.
==How to access overlays in a project==
====City====
[[File:Overlays-Icons.png|thumb|left|Overlay buttons in the [[Navigation Panel]] can be clicked to show that specific [[Overlay]]. The [[Parent Overlay]]s are indicated with the yellow rectangles and the [[Child Overlay]]s with the red rectangle]]
: ''The default view. This displays the [[game area]] in natural colors. Hovering over a location displays properties of the [[constructions|construction]] or [[behavior]] in that location.''
Overlays available to stakeholders appear as buttons on the right side of the interface. Clicking on any of these buttons will switch the view to the specific overlay. Clicking on the "City" overlay will switch the view back to default. Some overlays are {{inlink|Default Overlays|automatically added}} when a project is created. Some overlays are closely related to indicators, such as [[Heat Stress Overlay|Heat Stress]] and [[Livability (Overlay)|Livability.]]
====Ownership====
: ''This overlay is available by default. This overlay displays the [[ownership]] across the entire game area, using each stakeholder's colors. This is important when considering what stakeholder may construct a building where, or whom to negotiate with to [[land transactions|purchase land]].
====Zoning====
: ''This overlay is available by default. This overlay displays the [[zoning|zoning plan]] for the entire game area. This is helpful when considering indicators which are scored per zone, and when looking to construct a building which is restricted to certain zones.
====Livability====
: ''This overlay becomes available for each stakeholder with the [[Livability (Indicator)|livability indicator]]. It displays the average livability for each part of the game area, giving an indication of where the livability can best be increased.


==How to use overlays==
===Parent Overlay===
Overlays are added to the [[game]] automatically. Some overlays area added by default. Others are available based on the available indicators. To switch to a specific overlay, use the buttons just below the minimap. To switch back to the default view, switch to the "City" overlay.
Overlays can be grouped together using a Parent-Child hierarchy. Hovering over any of the Overlays in the [[Navigation Panel]] will show additional icons for the Child Overlays of that Overlay.
 
Every Overlay is considered a Parent Overlay, unless it has a Parent Overlay set, in which case it becomes a Child Overlay of that Parent Overlay. Overlays with Child Overlays cannot be a Child Overlay to another Overlay. [[Result Child Overlay]]s are always Child Overlays of other Overlays.
 
When a parent overlay is removed, it's child overlays are not removed, unless the child overlay is a result child type overlay. Otherwise, they simply have no parent overlay set anymore and become a parent overlay themselves.
{{clear}}
 
==List of available Overlays==
{{:Overlay Type}}
 
{{article end
|howtos=
'''General:'''
<div style="column-count:2">
* [[How to add and remove an Overlay]]
* [[How to add your own Overlay Icon]]
* [[How to hide an Overlay in the user interface]]
* [[How to sort Overlays]]
* [[How to edit an overlay legend]]
* [[How to use the Overlay Overview]]
</div>
'''Grid Overlay specific:'''
<div style="column-count:2">
* [[How to configure a Grid Overlay's legend]]
* [[How to set an Overlay to active or inactive]]
* [[How to delay Grid Overlay calculations]]
* [[How to force Grid Overlays to recalculate]]
* [[How to create an overlay for visualizing your own geographical vector information]]
* [[How to use a Grid Overlay to change the elevation model]]
* [[How to smooth Grid Overlay results]]
</div>
'''In/out:'''
<div style="column-count:2">
* [[How to export a Grid Overlay as ASCII]]
* [[How to export a Grid Overlay as GeoJSON]]
* [[How to export a Grid Overlay as GeoTIFF]]
* [[How to export a Grid Overlay as png]]
* [[How to show Overlays in Power BI]]
</div>
|notes=
* The following overlays are added automatically when creating a new project: [[City_Overlay|City]], [[Neighborhoods_(Overlay)|Neighborhoods]] and [[Ownership_(Overlay)|Ownership]]. Depending on the [[Project Source|project sources]], [[Zoning_(Overlay)|Zoning]] and [[Underground Overlay]] can also be added.
* [[Grid overlay]]s have the ability to show the [[Difference (Overlay)|difference]] between the maquette and the current state. The difference visualization uses its own legend, which can also be manually adjusted. The option to show the difference can be turned on or off per Grid Overlay.
* Overlays can be given [[Attribute]]s. Some of these Attributes are used by their calculation model.
* Some overlays can have the option to visualize different (intermediate) results of its calculation. These are configured using the [[Result_type|result types]]. For example, for the [[Water Overlay]] the [[Result_type_(Water_Overlay)|result types]] include the [[surface last value result type (Water Overlay)|surface last value result type]] and the [[ground watertable result type (Water Overlay)|groundwater result type]] for water above and below ground respectively.
* Some overlays store multiple [[Timeframes_(Water_Overlay)|timeframes]] of results. Examples are the [[Water Overlay]] and the [[Heat Stress Overlay]]. Each timeframe is a complete snapshot of results of the entire project area. These results can be viewed in sequence. When these overlays are visualized in the [[Web_Interface|2D map]], the last timeframe is shown.  
|seealso=
*[[Grid Overlay]]
|api=*[[Api session items overlays]]
}}
{{Overlay nav}}
{{Editor current situation nav}}
 
[[Category:Items]]

Latest revision as of 08:09, 1 May 2026

Overlay in comparison to Measurements, Indicators and Globals

An overlay is a layer visualized on top of the terrain and buildings in the 3D visualization. Overlays can provide spatial insight into specific subject, such as the variation of height and ownership. The visualized properties can originate from the current state of the project or from a result of a spatial calculation.

However, most overlays that can be added to a project use an underlying calculation model, which rasterize the spatial data and apply calculations to it to produce various (intermediate) results. These computational overlays can range from simple distance and average operations to complex water simulations. For these more complex Overlays with multiple results, additional Result Child Overlays can be added. The calculation main and child results will always be governed by the main overlay, also called the Result Parent Overlay.

How to access overlays in a project

Overlay buttons in the Navigation Panel can be clicked to show that specific Overlay. The Parent Overlays are indicated with the yellow rectangles and the Child Overlays with the red rectangle

Overlays available to stakeholders appear as buttons on the right side of the interface. Clicking on any of these buttons will switch the view to the specific overlay. Clicking on the "City" overlay will switch the view back to default. Some overlays are automatically added when a project is created. Some overlays are closely related to indicators, such as Heat Stress and Livability.

Parent Overlay

Overlays can be grouped together using a Parent-Child hierarchy. Hovering over any of the Overlays in the Navigation Panel will show additional icons for the Child Overlays of that Overlay.

Every Overlay is considered a Parent Overlay, unless it has a Parent Overlay set, in which case it becomes a Child Overlay of that Parent Overlay. Overlays with Child Overlays cannot be a Child Overlay to another Overlay. Result Child Overlays are always Child Overlays of other Overlays.

When a parent overlay is removed, it's child overlays are not removed, unless the child overlay is a result child type overlay. Otherwise, they simply have no parent overlay set anymore and become a parent overlay themselves.

List of available Overlays


Notes

How-to's

General:

Grid Overlay specific:

In/out:

See also

API Endpoints