Overlay: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Interface administrators, Administrators
34,490 edits
No edit summary
 
(325 intermediate revisions by 13 users not shown)
Line 1: Line 1:
{{learned|what an overlay is.|how overlays are implemented in the Tygron Engine.|how to access overlays.|which overlays exist.|}}
[[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.


{{clear}}
==How to access overlays in a project==
==How to access overlays in a project==
[[File:Overlays-Icons.jpg|thumb|left|How to access overlays]]
[[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]]
Overlays available to stakeholders appear as buttons just below the minimap. To switch to a specific overlay, use the button to switch to the designated overlay. To switch back to the default view, switch to the "City" overlay. Some overlays are default available when a project is created, see [[Overlays#Default_available_overlay_types| default available overlay types]]. Some overlays are very closely related to indicators (heat stress and livability).
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.]]
<br clear=all>


==Default available overlay types==
===Parent Overlay===
Multiple types of overlay exist in the Tygron Engine. All overlays which are available by default when creating a project are described below.
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.


====City====
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.
[[File:City-Overlay2.jpg|thumb|left|Default City overlay]]
: ''The default view. This displays the [[project detail area]] in natural colors. Hovering over a location displays properties of the [[constructions|construction]] or [[land]] type in that location.''
<br clear=all>
====Zoning====
[[File:Zoning-Overlay2.jpg|thumb|left|Default Zoning overlay]]
: ''This overlay is available by default. This overlay displays the [[zoning|zoning plan]] for the entire project detail 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.
<br clear=all>
====Property====
[[File:Property-Overlay2.jpg|thumb|left|Default Property overlay]]
: ''This overlay is available by default. This overlay displays the [[ownership]] of properties across the entire project area, using each stakeholder's colors. This is important when considering which stakeholder may perform actions such as constructing or demolishing at a given location, or whom to negotiate with for [[land transactions]].
<br clear=all>


==Optional overlay types==
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.
====Traffic Flow====
{{clear}}
[[File:Traffic_Flow-Overlay.jpg|thumb|left|Optional Traffic Flow overlay]]
 
: ''Main article: [[Traffic Flow (Overlay)| Traffic Flow (Overlay)]].
==List of available Overlays==
: ''This overlay displays the flow of traffic through roads. It becomes available for all stakeholders when added to a project.
{{:Overlay Type}}
<br clear=all>
 
<!--====Underground====
{{article end
: ''Main article: [[Underground (Overlay)| Underground (Overlay)]].
|howtos=
: ''This overlay displays [[constructions]] which are in the underground. The overlay becomes available for all stakeholders when added to a project.''
'''General:'''
====Safety Zone====
<div style="column-count:2">
: ''Main article: [[Safety Zone (Overlay)| Safety Zone (Overlay)]].
* [[How to add and remove an Overlay]]
: ''This overlay displays the Safety Zone as defined by [[constructions]]. The overlay becomes available for all stakeholders when added to a project.''-->
* [[How to add your own Overlay Icon]]
====Heat====
* [[How to sort Overlays]]
[[File:Heat-Overlay.jpg|thumb|left|Optional Heat overlay, linked to Heat indicator]]
* [[How to edit an overlay legend]]
: ''Main article: [[Heat (Overlay)| Heat (Overlay)]].
* [[How to use the Overlay Overview]]
: ''This overlay displays the Heat Stress. The overlay displays the average temperature deviation (positive or negative) for the project area, giving an indication of where the most heat-stress is occurring. This overlay only becomes available for each stakeholder with an [[Indicator_Weights|interest]] in the [[Heat_(Indicator)|Heat Stress indicator]]. In other words, the overlay is only visible when the heat indicator is also active for the selected stakeholder.''
</div>
<br clear=all>
'''Grid Overlay specific:'''
====Livability====
<div style="column-count:2">
[[File:Livability-Overlay.jpg|thumb|left|Optional Livability overlay, linked to Livability indicator]]
* [[How to configure a Grid Overlay's legend]]
: ''Main article: [[Livability (Overlay)| Livability (Overlay)]].
* [[How to set an Overlay to active or inactive]]
: ''This overlay displays the average livability for each part of the project detail area, giving an indication whether the livability is good, average or bad. This overlay becomes available for each stakeholder with an [[Indicator_Weights|interest]] in the [[Livability_(Indicator)|livability indicator]]. In other words, the overlay is only visible when the livability indicator is also active for the selected stakeholder.''
* [[How to delay Grid Overlay calculations]]
<br clear=all>
* [[How to force Grid Overlays to recalculate]]
<!--====Water Stress====
* [[How to create an overlay for visualizing your own geographical vector information]]
This overlay is deprecated.
* [[How to use a Grid Overlay to change the elevation model]]
====Terrain Sewer====
* [[How to smooth Grid Overlay results]]
This overlay is deprecated.-->
</div>
====Terrain Flooding====
'''In/out:'''
[[File:Terrain_Flooding-Overlay.jpg|thumb|left|Optional Terrain Flooding overlay]]
<div style="column-count:2">
: ''Main article: [[Terrain Flooding (Overlay)| Terrain Flooding (Overlay)]].
* [[How to export a Grid Overlay as ASCII]]
: ''This overlay displays active [[Terrains#Flooding_Terrain|flooding terrains]]. This overlay becomes available for each stakeholder.''
* [[How to export a Grid Overlay as GeoJSON]]
<br clear=all>
* [[How to export a Grid Overlay as GeoTIFF]]
====Terrains====
* [[How to export a Grid Overlay as png]]
[[File:Terrains-Overlay.jpg|thumb|left|Optional Terrains overlay]]
* [[How to show Overlays in Power BI]]
: ''Main article: [[Terrains (Overlay)| Terrains (Overlay)]].
</div>
: ''The Terrains overlay displays a combination of selected active terrains. This overlay becomes available for each stakeholder.''
|notes=
<br clear=all>
* 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.
<!--====Pipe network Financial====
* [[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.
====Pipe network Technical====-->
* Overlays can be given [[Attribute]]s. Some of these Attributes are used by their calculation model.
====Function Highlight====
* 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.
[[File:Function_Highlight-Overlay.jpg|thumb|left|Optional Function Highlight overlay]]
* 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.  
: ''Main article: [[Function Highlight (Overlay)]].
|seealso=
: ''This overlay highlights all constructions in the 3D world, for which the specific function has been selected, such as all shops in an area.''
*[[Grid Overlay]]
<br clear=all>
|api=*[[Api session items overlays]]
====Custom Color Areas====
}}
[[File:Custom_Color_Areas-Overlay.jpg|thumb|left|Optional Custom Color Areas overlay]]
{{Overlay nav}}
: ''Main article: [[Custom Color Area (Overlay)]].
{{Editor current situation nav}}
: ''This overlay shows colored areas in the 3D world, in locations defined in the editor.''
 
<br clear=all>
[[Category:Items]]
====Vacancy====
[[File:Vacancy-Overlay.jpg|thumb|left|Optional Vacancy overlay]]
: ''Main article: [[Vacancy (Overlay)]].
: ''This overlay shows all constructions in the project area which have been set as vacant in the Editor.''
<br clear=all>
====Image====
[[File:Image-Overlay.jpg|thumb|left|Optional Image overlay]]
: ''Main article: [[Image (Overlay)]].
: ''This overlay projects a custom image over the project area.''
<br clear=all>
==Adding and removing overlays==

Latest revision as of 08:34, 22 April 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

Icon Name Type Category Data Displays
City Default None The default view without any overlay
Ownership OWNERSHIP Administrative Feature Ownership of constructions/ plots
Ownership Grid OWNERSHIP_GRID Administrative Grid Ownership of constructions/ plots
Municipalities MUNICIPALITIES Administrative Feature Municipalities in the project area
Neighborhoods NEIGHBORHOODS Administrative Feature Neighborhoods in the project area
Vacancy VACANCY Administrative Feature Constructions marked as vacant are highlighted
Zipcodes ZIP_CODES Administrative Feature Postal codes
Zoning ZONING Administrative Feature Zoning (related to zoning plans)
Heat Stress HEAT_STRESS Environmental Grid Urban heat stress
Livability LIVABILITY Environmental Grid Livability score
Shadow SHADOW Environmental Grid Shadow
Traffic Density TRAFFIC_DENSITY Environmental Grid Traffic density
Traffic Noise TRAFFIC_NOISE Environmental Grid Impact of traffic noise polution on surrounding area
Traffic NO2 TRAFFIC_NO2 Environmental Grid Impact of traffic NO2 polution on surrounding area
Flooding FLOODING Water Grid Impact of flooding on inundation
Groundwater GROUNDWATER Water Grid Underground water tables
Rainfall RAINFALL Water Grid Impact of rainfall on inundation
Subsidence SUBSIDENCE Water Grid Areas subject to subsidence
Watershed WATERSHED Water Grid Discharge areas based on DTM or Water overlay's flow direction.
Average AVG Grid Calculation Grid Smoothened values of grid cells
Combo COMBO Grid Calculation Grid Combines up to three grid overlays using mathematical functions and boolean operators.
Distance DISTANCE Grid Calculation Grid Defined contour around an object
Sight Distance SIGHT_DISTANCE Grid Calculation Grid Combined distance zone with line of sight
Travel Distance TRAVEL_DISTANCE Grid Calculation Grid Contour based on travel distance
Inference INFERENCE Grid Calculation Grid AI Inference
Iteration ITERATION Grid Calculation Grid Iteration Collector
Area AREA Geo Data Feature Selection of Areas
Attribute ATTRIBUTE Geo Data Feature Presence of a specific attribute in a data layer
Function FUNCTION Geo Data Feature Highlights specific functions/ buildings
GeoTIFF GEO_TIFF Geo Data Grid External data in GeoTIFF format
Image IMAGE Geo Data Grid A custom image
WCS WCS Geo Data Grid Stores the GeoTIFF result of a Web Coverage Service as a Grid Overlay.
WMS WMS Geo Data Grid Stores the result of a Web Image Service as a Grid Overlay.
Satellite SATELLITE Topography Grid Satellite Imagery
Digital Surface Model HEIGHTMAP Topography Grid Height of the terrain and building heights (DSM)
Digital Terrain Model HEIGHTMAP Topography Grid Height of the terrain (DTM)
Source SOURCE Topography Feature Datasets/sources currently in use for generating the project
Underground UNDERGROUND Topography Feature Underground composition
Network Distance NETWORK_DISTANCE Networks Feature Distance to lines of a network
Network Overview NETWORK_OVERVIEW Networks Feature Lines, loads and cluster topography of a network
Network Ownership NETWORK_OWNERSHIP Networks Feature Ownership of lines, loads and clusters of a network


Notes

How-to's

General:

Grid Overlay specific:

In/out:

See also

API Endpoints

Overlays
Categorization
Grid • Overlay Type • Parent • Result Child • Result Parent • Result type
Default
City
Administrative
Ownership • Ownership Grid • Zipcodes • Zoning • Neighborhoods • Municipalities • Scenario
Environmental
Heat Stress • Shadow • Traffic Density • Traffic Noise • Traffic NO2 • Livability
Water
Rainfall • Flooding • Groundwater • Watershed
Grid Calculation
Average • Combo • Distance • Sight Distance • Travel Distance • Inference • Iteration
Geo Data
GeoTIFF • WCS • WMS • Image • Area • Attribute • Function
Topography
Satellite • Digital Surface Model • Digital Terrain Model • Building Floors • Underground • Source
Network
Network Distance • Network Overview • Network Ownership


Current Situation
Current Situation
Buildings • Terrains • Administrative • Areas • Networks • Overlays • Indicators • Panels • Globals •  Queries • Geo Import
Buildings
Function • Function Override • Category • Custom Geometry • Category Value • Function Value • Function Values Table
Traffic
Unit Type • Unit Data • Unit Data Override
Terrain
Height sector • Elevation model • Elevation GeoTIFF • Elevation Grid Overlay • Ground Price • Terrain Type • Terrain Type Override
Administrative
Neighborhood • Zone • Permission Popup • Plot • Zip Code
Geo Import
Source • GeoShare
Network
Net Cluster • Net Function • Net Line • Net Load • Net Node • Net Setting
Editor
Current Situation • Future Design • Multi Scenario • Tools • Community
Retrieved from "https://support.tygron.com/w/index.php?title=Overlay&oldid=78449"