|Location||_location||The output from the "importEPW" or "constructLocation" component. This is essentially a list of text summarizing a location on the Earth.
"timeZone" and "elevation" data from the location, are not important for the creation of a Terrain shading mask.||Goo|
|Context||context_||Input every kind of context to this input: buildings, houses, trees; and all the other objects: PV/SWHsurfaces or planar "_geometry" (surface) on which the future analysis (view, sunlight hours, radiation...) will be conducted.
This input is important for calculation of the final radius of the Terrain shading mask (that's "maskRadius" output). The larger the context_ input, the Terrain shading mask radius might be longer.
For sunpath visualization purposes, you can make this input empty (not supply anything to it). In this way the "maskRadius" output will always be equal to 200 meters (655 feets) which corresponds to the _sunPathScale_ = 1 input of the Ladybug_Sunpath component.
If nothing supplied to the context_ input, the default Terrain shading mask radius of 200 meters (655 feets) will be used.||Goo|
|Min Visibility Radius||minVisibilityRadius_||Horizontal distance FROM which the surrounding terrain will be taken into account. Anything closer than that will not be considered for creation of a Terrain shading mask.
Unless you are doing an analysis of large areas, for example longer than 200 meters in radius (e.g. city's blocks) do not change this input's default value (0)!
If it is not equal to 0, it can not be shorter than 0.1 km nor longer than 10 km.
Also it must not be longer than one third of maxVisibilityRadius_. For example, if maxVisibilityRadius_ is 27, the maximal minVisibilityRadius_ can not be longer than 9.
It should be mentioned that every number supplied to the minVisibilityRadius_ input will by rounded at 1 decimal. For example, if you supply: 0.2345, it will be rounded to 0.2 kilometers.
This input depends on the radius of your context geometry (that's "contextRadius" output). If the radius of your context geometry ranges up to 200 meters (which will likely happen in most cases), just keep the minVisibilityRadius_ equal to 0.
However, if you intend to use Terrain shading mask for a context whose radius is a couple of hundreds of meters (e.g. solar radiation analysis of a city block), you need to remove the terrain very near to your _location.
This is what the minVisibilityRadius_ input is used for. For example you can use the value 3 times the radius of your contextRadius: let's say the radius of your context is 600 meters, then you can use the minVisibilityRadius_ of 1.8 km.
If not supplied, default value of 0 km will be used (all the terrain from the _location point will be taken into account up to maxVisibilityRadius_).
|Max Visibility Radius||maxVisibilityRadius_||Horizontal distance TO which the surrounding terrain will be taken into account. Anything beyond that will not be considered for creation of a Terrain shading mask.
It can not be shorter than 1km or longer than 400 km.
The component itself might inform the user to alter the initial maxVisibilityRadius_ inputted by the user.
This is due to restriction of topography data, being limited to 56 latitude South to 60 latitude North range. If maxVisibilityRadius_ value for chosen location gets any closer to the mentioned range, the component will inform the user to shrink it for a certain amount, so that the maxVisibilityRadius_ stops at the range limit.
If not supplied, default value of 100 km will be used.
|_______________||Script variable TerrainShadingMask||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|
|Mask Style||maskStyle_||The style of the mask
0 - spherical terrain shading mask - the terrain shading mask "is cut" from a half sphere.
1 - extruded (vertical) terrain shading mask - the terrain shading mask "is cut" from a cylinder.
!!! NOTICE !!! Changing maskStyle_ input will result in reruning the component from the very start, and creating a new Terrain shading mask. This can be time consuming.
It could be better, in order to see how extruded(1) maskStyle_ looks like, to lower the value of the maxVisibilityRadius_ input to 10, for example.
In this way, the time needed for reruning the component and creating a new Terrain shading mask will vastly be reduced.
Once you see the effect of extruded maskStyle_, in case you prefer it over the spherical(0) maskStyle_, simply edit the maxVisibilityRadius_ input to the value it had before you lowered it to 10.
If not supplied, 0 will be used as a default (spherical terrain shading mask).||Goo|
|Working Folder||workingFolder_||Folder path where downloaded and created terrain shading mask files will be located.
This component may download topography files up to 600 MB in size from the Internet, and then create the Terrain shading masks from them.
Make sure that the "workingFolder_" you choose is a hard disk partition with enough space on it.
If not supplied, the default Gismo folder path will be used: "c:\gismo\terrain_shading_masks".||Goo|
|Download Url||downloadUrl_||Address of a web page which contains download links of already created Terrain shading masks.
This component downloads a topography data first, then creates a terrain model from it, and in the end creates a Terrain shading mask.
Mentioned process can be both time consuming (component may ran for 10 minutes) or even crash your Rhino 5, in case you have 32 bit Rhino 5 with lower performance PC.
In order to avoid this, a number of premade Terrain shading masks will be uploaded to the Internet. Another reason for uploading premade masks is that some of them might not be able to be created with this component. But they could be directly downloaded through downloadUrl_ input.
Downloading a premade Terrain shading mask can last only a couple of seconds.
!!! NOTICE !!! Only premade Terrain shading masks with minVisibilityRadius_ = 0, maxVisibilityRadius_ = 100 and maskStyle_ = 0 (spherical) will be uploaded!
So if you would like to download a premade Terrain shading mask, make sure that you set your inputs to the same upper mentioned values (minVisibilityRadius_ = 0, maxVisibilityRadius_ = 100, maskStyle_ = 0).
If not supplied, the following default downloadUrl_ input will be used
|_______________||Script variable Python||Goo|
|Bake It||bakeIt_||Set to "True" to bake the Terrain shading mask results into the Rhino scene.
If not supplied default value "False" will be used.||Goo|
|Run It||_runIt||!!! ATTENTION !!! This component may crash Rhino 5 application due to requirement to generate large topography data! To prevent this, it is suggested to own a 64 bit version of Rhino 5 and have strong enough PC configuration.
If you do not have either of these two, try keeping the maxVisibilityRadius_ value to its default value: 100.
Also try saving your .gh definition before running this component.||Goo|