Skip to content

Commit

Permalink
[UPDATE] Added documentation for **Labs Biome Attributes to Terrain S…
Browse files Browse the repository at this point in the history
…OP**, edited existing documentation.
  • Loading branch information
baileycc committed Oct 16, 2024
1 parent befdf05 commit f322f79
Show file tree
Hide file tree
Showing 3 changed files with 103 additions and 1 deletion.
1 change: 1 addition & 0 deletions help/nodes/sop/labs--biome_attributes_evolve-1.0.txt
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Display:
<p>__Temperature__: A remapped preview of the `temperature` attribute on the terrain.</p>
<p>__Precipitation__: A remapped preview of the `precipitation` attribute on the terrain.</p>
<p>__Soil__: A preview of the `soil` attribute on the terrain.</p>
<p>__Biome Color__: A preview of the `color` attribute on the terrain.</p>

Auto Remap:
#id: autoremap
Expand Down
98 changes: 98 additions & 0 deletions help/nodes/sop/labs--biome_attributes_to_terrain-1.0.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
= Labs Biome Attributes to Terrain =

"""Assign the base biome attributes onto the terrain """

This nodes takes the default attributes and/or the dictionary attribute `biome_definition` of the second input and transfers them to the terrain depending on the biome regions of the third input.

@parameters

== Visualize ==

Display:
#id: display
<p>__Input__: The terrain `mask` input in the node.</p>
<p>__Temperature__: A remapped preview of the `temperature` attribute on the terrain.</p>
<p>__Precipitation__: A remapped preview of the `precipitation` attribute on the terrain.</p>
<p>__Soil__: A preview of the `soil` attribute on the terrain.</p>
<p>__Biome Color__: A preview of the `color` attribute on the terrain.</p>

Auto Remap:
#id: autoremap
<p>__Use Real-World Range__: Show a remapped preview of the __Display__ following real-world preset values.</p>
<p>__Auto Normalize Range__: Show a normalized preview of the __Display__ following the minimum and maximum volume values.</p>
<p>__Manual Range__: Show a remapped preview of the __Display__ following __Min__ and __Max__ values.</p>

=== AUTOREMAP ===

Compute Range:
#id: computerange
Click to fill in the __Min__ and __Max__ parameters with the current minimum and maximum values in the input layer.

Min:
#id: inputmin
The lowest value in the input to map from.

Max:
#id: inputmax
The highest value in the input to map from.

== Parameters ==

== Default Attributes ==

Color:
#id: biomecolor
Color that is applied to the visualizer.

Temperature:
#id: temperature
Average annual temperature (in °C) of this biome.

Precipitation:
#id: precipitation
Average annual precipitation (in mm) of this biome.

== Output ==

=== HeightField Layers ===

Temperature:
#id: tempname
Name of `temperature` mask.

Precipitation:
#id: precname
Name of `precipitation` mask.

Soil:
#id: soilname
Name of `soil` mask.

Biome ID:
#id: biomeidname
Name of `biome ID` mask.

Biome Color R:
#id: biomecolorrname
Name of the red channel of the `biome color` mask.

Biome Color G:
#id: biomecolorgname
Name of the green channel of the `biome color` mask.

Biome Color B:
#id: biomecolorbname
Name of the blue channel of the `biome color` mask.

Biome Average Height:
#id: biomeavgheightname
Name of `average height` mask.



@locals


@related
- [Labs Biome Define|Node:sop/labs--biome_define-1.0]
- [Labs Biome Definitions File|Node:sop/labs--biome_definitions_file-1.0]
5 changes: 4 additions & 1 deletion help/nodes/sop/labs--biome_plant_scatter-1.0.txt
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,10 @@ This node scatters plant species points defined by multiple _Labs Biome Plant De
Percentage of points that are not culled.
Enable Mask:
#id: enablemask
Enables the masking of points by the third input. A heightfield mask and/or geometry will be subtracted from the soil mask to prevent plants from scattering in the masked area.
Enables the masking of points by the third input. A heightfield mask and/or geometry will be subtracted from the soil mask to prevent plants from scattering in the masked area.
Invert Mask:
#id: invertmask
Enable to invert the mask of input 3. If enabled, the red areas of the input mask will be subtracted from the scatter.

=== Incomplete Age Coverage ===

Expand Down

0 comments on commit f322f79

Please sign in to comment.