Water Connection Generator: Difference between revisions

Latest revision as of 15:27, 7 October 2022

The Water Connection Generator enables users to generate (and remove) underground buildings using a set of parameters. This generator can be used for example when creating a project with the Water Overlay, but a dataset with all culverts is not available. With the water connection generater, the culverts can be generated. The parameters are explained below under Advanced Options. The water connection generator panel can be found in the Current Situation tab:

Editor → Current Situation (Ribbon tab) → Buildings (Ribbon bar) → Generate Water Connections (Dropdown)

To get started with the Water Connection Generator, see the Demo Create Culverts project which is available in your domain.

Options

Select the function and the location of the to be generated connections

There are a few basic options which form the foundation of using the Water Connection Generator. These options are displayed at the top of the Water Connection Generator's window.

Function

What Function should be applied to the buildings generated by the Water Connection Generator. Due to the nature of water connections, only Functions of the underground Function Category can be selected.

Applied on

Where the new buildings should be generated. The following settings are allowed:

Entire map: Generate buildings across the entire map.
Nearby area: Generate buildings only in the vicinity of the Camera's current location. This is everything currently visible by the camera, or within 250m of what is currently visible by the camera.
Specific neighborhood: Generate buildings only in a specific Neighborhood.

Advanced Options

The advanced options

There are a variety of advanced options available which allow fine-tuning the exact circumstances under which buildings are or aren't generated. The provided defaults are meant to allow using the Water Connection Generator and getting reasonable result with minimal effort, but by further refining the generator's configuration its possible to improve the results for a given location and use-case.

Minimum and maximum length

Both the minimum and maximum length in meters can be provided to set the length of the created water connections and to limit the amount of created connections. The length is measured as the closest points between two water bodies.

Large road threshold

A road is considered large (and therefore impassable by a water connection) when the road's size is larger than the set threshold value. This parameter can be used to prevent water connections crossing large roads. The large road threshold is provided as a surface size in m2. The surface size of each road polygon is then checked against the threshold value.

Large road straight

In this schematic image, the large road straight setting is set on 30m. Only one water connection is generated, since there is one waterway that is perpendicular to another waterway.

The large road straight parameter is used to measure if waterways are perpendicular to each other. It is measured by extending the placed water connection by x meters and if it is still in a waterway or body, then it is perpendicular and accepted. For parallel waterways, this check will not create a water connection when the defined x is sufficiently large.

Maximum height difference

Two waterways with a levee inbetween. A stricter max height difference can prevent the creation of an unrealistic water connection.
Two waterways, of which one is situated 5 meters lower than the other, where there typically would be no water connection.

The maximum height difference in meters that is allowed for the water connection te be generated. The height difference is measured on the surface where the water connection would be. This parameter can therefore be used to detect levees on the surface and prevent water connections through them. Additionally, this same parameter can be used to prevent connections being created for water ways that have very different water levels.

Width

The generated water building will have its width set to this value when generated. The width is provided in meters. For culverts, the width will be the culvert diameter.

Ignore upstream (beta)

Sometimes multiple water connections can be created between two waterways. This can be acceptable when both are situated at the same datum height, but when situated at a slope, it is more desirable to ignore the higher one. See the following images for a situation where this option can be useful. By Default this option is ignored by setting the value >= 100.

Upstream situation, the lowest waterway can connect to each of the waterways north of it. The greener parts are 2 meters lower than the yellow parts.
By default, it connects to both waterways. The north-eastern waterway also creates a connection, but at a location slightly to the left.
By configuring the ignore upstream parameter to 1 meter, the upper connection for the southern waterway is not created, leading to only three culverts. The north eastern waterway still makes a connection, because in its situation a culvert is still desirable.

Include water bodies

When selected, both waterways and water bodies are taken into account as water terrains where water connections to and from are generated. When not selected, only waterways are taken into account.

Reset and remove

Reset and remove buttons

The Reset to defaults action reverts the values of the advanced options back to the default settings.
The Remove generated action removes all generated buildings of the selected function. Note that this also removes not generated buildings of this function. For example buildings which were imported or manually drawn.

Notes

To get started with the Water Connection Generator, see the Demo Create Culverts project which is available in your domain.

@@ Line 1: / Line 1: @@
-The Water Connection Generator enables users to generate underground [[buildings]] such as culverts using a set of parameters. This generator is useful in situations where a project misses a large number of these constructions. Generated constructions can be easily removed as well, to retry with different parameters. The parameters are explained below under [[#Advanced Options|Advanced Options]].
+__NOTOC__
+The Water Connection Generator enables users to generate (and remove) underground [[buildings]] using a set of parameters. This generator can be used for example when creating a project with the [[Water Overlay]], but a dataset with all culverts is not available. With the water connection generater, the [[Culvert_(Water_Overlay)|culverts]] can be generated.
+The parameters are explained below under {{inlink|Advanced Options}}.
+The water connection generator panel can be found in the Current Situation tab:
+{{editor location|Buildings|dropdown=Generate Water Connections}}
-[[File:WaterConnectionGenerator.png]]
+[[File:Water_connection_generator.PNG|The Water Connection Generator panel|400px]]
+''To get started with the Water Connection Generator, see the [[Demo_Create_Culverts_Project|Demo Create Culverts project]] which is available in your domain.''
+==Options==
+[[File:Water_connection_generator_function.png|thumb|right|200px|Select the function and the location of the to be generated connections]]
+There are a few basic options which form the foundation of using the Water Connection Generator. These options are displayed at the top of the Water Connection Generator's window.
+===Function===
+What [[Function]] should be applied to the [[building]]s generated by the Water Connection Generator. Due to the nature of water connections, only [[Function]]s of the underground [[Function Category]] can be selected.
+===Applied on===
+Where the new [[building]]s should be generated. The following settings are allowed:
+* Entire map: Generate [[building]]s across the entire map.
+* Nearby area: Generate [[building]]s only in the vicinity of the [[Camera]]'s current location. This is everything currently visible by the camera, or within 250m of what is currently visible by the camera.
+* Specific neighborhood: Generate [[building]]s only in a specific [[Neighborhood]].
+{{clear}}
 ==Advanced Options==
-===Mininimum and maximum length===
+[[File:Water_connection_generator_advanced.png|thumb|right|200px|The advanced options]]
-Both the minimum and maximum length can be provided to limit the amount of created water constructions. The length is measured as the closest points between two water bodies.
+There are a variety of advanced options available which allow fine-tuning the exact circumstances under which [[building]]s are or aren't generated. The provided defaults are meant to allow using the Water Connection Generator and getting reasonable result with minimal effort, but by further refining the generator's configuration its possible to improve the results for a given location and use-case.
+===Minimum and maximum length===
+Both the minimum and maximum length in meters can be provided to set the length of the created water connections and to limit the amount of created connections. The length is measured as the closest points between two water bodies.
 ===Large road threshold===
-A road is considered large (and therefor impassable) when the road's size is larger than the threshold. This parameter can be used to prevent water connections crossing large roads. The large road threshold is provided as a surface size in m2.
+A road is considered large (and therefore impassable by a water connection) when the road's size is larger than the set threshold value. This parameter can be used to prevent water connections crossing large roads. The large road threshold is provided as a surface size in m2. The surface size of each road polygon is then checked against the threshold value.
 === Large road straight===
-Large road straight (m).
+[[File:Large_road_straight_setting2.png|thumb|left|300px|In this schematic image, the large road straight setting is set on 30m. Only one water connection is generated, since there is one waterway that is perpendicular to another waterway.]]
+The large road straight parameter is used to measure if waterways are perpendicular to each other. It is measured by extending the placed water connection by x meters and if it is still in a waterway or body, then it is perpendicular and accepted. For parallel waterways, this check will not create a water connection when the defined x is sufficiently large.
+{{clear}}
 === Maximum height difference ===
-The height differences on the surface along the line of the water connection. This parameter can be used to detect dikes and prevent water connections under them. Additionally, this same parameter can be used to prevent connections being created for water ways that have water levels that are too far apart.
+<div class='tleft'><ul style='margin-left:unset;'>
-[[File:water_connection_max_height.jpg|400px|thumb|left|Two waterways with a levee in between. A stricter max height difference can prevent the creation of an unrealistic water connection.]]
+<li style = "display:inline-block">[[File:water_connection_max_height.jpg|300px|thumb|none|Two waterways with a levee inbetween. A stricter max height difference can prevent the creation of an unrealistic water connection.]]</li>
-[[File:water_connection_height_difference.jpeg|400px|thumb|Two waterways, of which one is situated 5 meters lower than the other.]]
+<li style = "display:inline-block">[[File:water_connection_height_difference.jpeg|300px|thumb|none|Two waterways, of which one is situated 5 meters lower than the other, where there typically would be no water connection.]]</li>
-<br style="clear:both">
+</ul></div>
+The maximum height difference in meters that is allowed for the water connection te be generated. The height difference is measured on the surface where the water connection would be. This parameter can therefore be used to detect levees on the surface and prevent water connections through them. Additionally, this same parameter can be used to prevent connections being created for water ways that have very different water levels.
+{{clear}}
 === Width ===
-The construction will have its width set to this value when placed. The width is provided in meters.
+The generated water building will have its width set to this value when generated. The width is provided in meters. For [[Culvert_(Water_Overlay)|culverts]], the width will be the [[Culvert_diameter_(Water_Overlay)|culvert diameter]].
+=== Ignore upstream (beta) ===
+Sometimes multiple water connections can be created between two waterways. This can be acceptable when both are situated at the same datum height, but when situated at a slope, it is more desirable to ignore the higher one. See the following images for a situation where this option can be useful. By Default this option is ignored by setting the value >= 100.
-=== Ignore upstream ===
+<div class='tleft'><ul style='margin-left:unset;'>
-A water connection is only created when its endpoints differ in height less than this configured value. This parameter can be used to prevent connections being created for water ways that have water levels that are too far apart.
+<li style = "vertical-align: top;display:inline-block">[[File:Water_connection_generator_upstream1.png|thumb|left|x150px|Upstream situation, the lowest waterway can connect to each of the waterways north of it. The greener parts are 2 meters lower than the yellow parts.]]</li>
-[[File:water_connection_height_difference|400px|thumb|Two waterways, of which one is situated 5 meters lower than the other. The ignore upstream parameter of
+<li style = "vertical-align: top;display:inline-block">[[File:Water_connection_generator_upstream2.png|thumb|left|x150px|By default, it connects to both waterways. The north-eastern waterway also creates a connection, but at a location slightly to the left.]]</li>
+<li style = "vertical-align: top;display:inline-block">[[File:Water_connection_generator_upstream3.png|thumb|left|x150px|By configuring the ignore upstream parameter to 1 meter, the upper connection for the southern waterway is not created, leading to only three culverts. The north eastern waterway still makes a connection, because in its situation a culvert is still desirable.]]</li>
+</ul></div>
+<br style="clear:both">
 === Include water bodies ===
-When selected, both [[waterways]] and [[water bodies]] are taken into account as water terrains. When not selected, only waterways are taken into account.
+When selected, both [[Terrain_Type#Surface|waterways]] and [[Terrain_Type#Surface|water bodies]] are taken into account as water terrains where water connections to and from are generated. When not selected, only [[Terrain_Type#Surface|waterways]] are taken into account.
+==Reset and remove==
+[[File:Water_connection_generator_reset.png|thumb|right|200px|Reset and remove buttons]]
-=== Optional actions===
 * The '''Reset to defaults''' action reverts the values of the advanced options back to the default settings.
-* The '''Remove generated''' action removes all generated constructions of the indicated function.
+* The '''Remove generated''' action removes all generated buildings of the selected function. Note that this also removes not generated buildings of this function. For example buildings which were imported or manually drawn.
+{{clear}}
+{{article end
+|notes=
+* To get started with the Water Connection Generator, see the [[Demo_Create_Culverts_Project|Demo Create Culverts project]] which is available in your domain.
+|seealso=
+* [[Culvert (Water Overlay)]]
+* [[Hydraulic structures (Water Overlay)]]
+* For more information on the use of the water connection generator, see this video (Dutch only):
+[[File:YoutubeLogo1.jpg|thumb|left|link=https://youtu.be/Ac2yAKAh9aY|Editing the Water Connection Generator (Dutch Only)]]
+|howtos=
+* [[How to use the Water Connection Generator to generate Buildings]]
+* [[How to use the Water Connection Generator with advanced options to generate Buildings]]
+* [[How to remove Buildings generated by the Water Connection Generator]]
+}}

Water Connection Generator: Difference between revisions

Latest revision as of 15:27, 7 October 2022