Analysis Type | _analysisType | Choose one of the terrain analysis types:
0 - Slope
1 - Grade
2 - Aspect
3 - Elevation
4 - Visibility
5 - Hillshade
6 - TRI (Terrain Ruggedness Index by Riley)
7 - TRI categories (Terrain Ruggedness Index categories by Riley)
8 - SRF (Surface Roughness Factor by Hobson)
9 - TPI (Topographic Position Index)
10 - Mean curvature | Goo |
| _______________ | Script variable TerrainGenerator2 | Goo |
Terrain | _terrain | A terrain surface or polysurface.
Add it by supplying the "terrain" output from the Ladybug "Terrain Generator" or Gismo "Terrain Generator" components.
-
It needs to be a surface. So set the:
"type_" input of the Ladybug "Terrain Generator" component to "1"
or
"type_" input of the Gismo "Terrain Generator" component to "2" or "3" | Goo |
Origin | _origin | An origin (point on a "_terrain") of the upper "_terrain" input.
Add it by suppling the "origin" output from the Ladybug "Terrain Generator" component.
or
Add it by supplying the "origin" output from the Gismo "Terrain Generator" component. | Goo |
Elevation | _elevation | Elevation of the upper "_origin".
Add it by supplying the "elevation" output from the Ladybug "Terrain Generator" component.
or
Add it by supplying the "elevation" output from the Gismo "Terrain Generator" component.
-
In Rhino document units. | Goo |
Context | context_ | These are obstacles surrounding your location: houses, buildings, trees etc.
For example, you can use 3d buildings and 3d trees generated by Gismo's "OSM 3D" component.
-
This input can not be included in the final "analysedTerrain" geometry for the following indices: TRI, TRI categories, SRF, TPI (_analysisType = 6,7,8,9)
The reason for this is because these indices exclusively calculate terrain features. | Goo |
North | north_ | Input a vector to be used as a true North direction, or a number between 0 and 360 that represents the clockwise degrees off from the Y-axis.
-
If not supplied, default North direction will be set to the Y-axis (0 degrees). | Goo |
Sun Vector | sunVector_ | Illuminance source direction.
This input is only used for _analysisType = 5 (Hillshade).
-
If not supplied, default sunVector of (0, 2.37126, -2.37126) will be used (an Y+ vector angled at 45 degrees downwards). | Goo |
Hypso Strength | hypsoStrength_ | Hypsometric strength - a factor which determines shading factor's intensity due to elevation differences of terrain vertices.
It ranges from 0 to 100.
-
This input is only used for _analysisType = 5 (Hillshade).
-
If not supplied, default hypsoStrength of 50 will be used. | Goo |
Refine | refine_ | Refines the "analysedTerrain" output's mesh to finer resolution (halves the Maximum edge length of the "analysedTerrain" mesh).
-
Final "analysedTerrain" output is created with a certain mesh resolution.
Depending on your terrain, sometimes a mesh resolution of higher precision is required.
Be cautious !!! Due to "analysedTerrain" mesh increased number of vertices-faces, setting refine_ to True, can result in much longer component runtime !!!
Still if your PC configuration is strong enough, you can always set this input to "True". Except for the _analysisType = 7 (TRI categories). In that case the refine_ input will not make any effect on the final "analysedTerrain" mesh.
-
If not supplied, the refine_ input will be set to False by default. | Goo |
Legend Bake Par | legendBakePar_ | Optional legend parameters from the Gismo "Legend Bake Parameters" component. | Goo |
| _______________ | Script variable TerrainGenerator2 | Goo |
Bake It | bakeIt_ | Set to "True" to bake the terrain analysis geometry into the Rhino scene.
-
If not supplied default value "False" will be used. | Goo |
Run It | _runIt | ... | Goo |