Merge pull request #1175 from t3kt/0.38

0.38

docs/_includes/paramHandling.html

@@ -0,0 +1,8 @@
+{% case include.handling %}
+	{% when "runtime" %}
+		<span title="Can change efficiently">Runtime</span>
+	{% when "macro" %}
+		<span title="Causes a recompile when changed">Baked</span>
+	{% when "constant" %}
+		<span title="Might cause a partial recompile when changed">Semi-Baked</span>
+{% endcase %}

docs/_layouts/operator.html

@@ -83,24 +83,43 @@ <h1>{{ page.op.name }}</h1>
 {% if page.op.parameters %}
 	<h2>Parameters</h2>
 
-	<ul>
-		{% for param in page.op.parameters %}
-		<li>
-			<code class="param-name" title="{{ param.name }}">{{ param.label }}</code>:
-			<span class="param-desc">{{ param.summary }}</span>
+	<table class="param-table">
+		<thead>
+		<tr>
+				<th>Name</th>
+				<th>Description</th>
+				<th>Regular Handling</th>
+				<th>Read-Only Handling</th>
+			</tr>
+		</thead>
+		<tbody>
+			{% for param in page.op.parameters %}
+			<tr>
+				<td><code class="param-name" title="{{ param.name }}">{{ param.label | default: param.name }}</code></td>
+				<td class="param-desc">{{ param.summary | markdownify }}</td>
+				<td class="param-handling">
+					{%include paramHandling.html handling=param.regularHandling %}
+				</td>
+				<td class="param-handling">
+					{%include paramHandling.html handling=param.readOnlyHandling %}
+				</td>
+			</tr>
 			{% if param.menuOptions %}
-			<ul>
-				{% for opt in param.menuOptions %}
-				<li>
-					<code class="menu-opt-name" title="{{ opt.name }}">{{ opt.label }}</code>:
-					<span class="menu-opt-summary">{{ opt.description }}</span>
-				</li>
-				{% endfor %}
-			</ul>
+			<tr>
+				<td class="param-menu-opts" colspan="4">
+					<ul>
+						{% for opt in param.menuOptions %}
+						<li>
+							<code class="menu-opt-name" title="{{ opt.name }}">{{ opt.label }}</code>:
+							<span class="menu-opt-summary">{{ opt.description }}</span>
+						</li>
+						{% endfor %}
+					</ul>
+			</tr>
 			{% endif %}
-		</li>
-		{% endfor %}
-	</ul>
+			{% endfor %}
+		</tbody>
+	</table>
 {% endif %}
 
 {% if page.op.inputs %}

docs/_reference/operators/camera/basicCamera.md

@@ -13,12 +13,18 @@ op:
   parameters:
   - label: FOV Angle
     name: Camfov
+    readOnlyHandling: macro
+    regularHandling: runtime
     summary: Width of the view angle.
   - label: Position
     name: Campos
+    readOnlyHandling: macro
+    regularHandling: runtime
     summary: Position of the camera.
   - label: Rotate
     name: Camrot
+    readOnlyHandling: macro
+    regularHandling: runtime
     summary: Rotation of the camera view direction.
   summary: Standard camera equivalent to a traditional Camera COMP with default settings.
 

docs/_reference/operators/camera/fieldCamera.md

@@ -31,6 +31,8 @@ op:
   parameters:
   - label: Position
     name: Campos
+    readOnlyHandling: macro
+    regularHandling: runtime
     summary: Position of the camera.
   status: beta
 

docs/_reference/operators/camera/fisheyeCamera.md

@@ -34,19 +34,31 @@ op:
     name: Fisheyemode
   - label: Aperture
     name: Aperture
+    readOnlyHandling: macro
+    regularHandling: runtime
   - label: Position
     name: Campos
+    readOnlyHandling: macro
+    regularHandling: runtime
     summary: Position of the camera.
   - label: Rotate
     name: Camrot
+    readOnlyHandling: macro
+    regularHandling: runtime
     summary: Rotates the camera in XYZ.
   - label: Look At Position
     name: Lookatpos
+    readOnlyHandling: macro
+    regularHandling: runtime
     summary: Coordinates that the camera should face.
   - label: Up Vector
     name: Camup
+    readOnlyHandling: macro
+    regularHandling: runtime
   - label: Enable Look At
     name: Enablelookat
+    readOnlyHandling: constant
+    regularHandling: runtime
   summary: A 360 fisheye camera, that shows all directions from a specific point in
     space.
   thumb: assets/images/reference/operators/camera/fisheyeCamera_thumb.png

docs/_reference/operators/camera/lookAtCamera.md

@@ -13,18 +13,28 @@ op:
   parameters:
   - label: FOV Angle
     name: Camfov
+    readOnlyHandling: macro
+    regularHandling: runtime
     summary: FOV angle.
   - label: Position
     name: Campos
+    readOnlyHandling: macro
+    regularHandling: runtime
     summary: Position of the camera.
   - label: Rotate
     name: Camrot
+    readOnlyHandling: macro
+    regularHandling: runtime
     summary: Rotation of the camera in XYZ.
   - label: Look At Position
     name: Lookatpos
+    readOnlyHandling: macro
+    regularHandling: runtime
     summary: Position that the camera faces.
   - label: Up Vector
     name: Camup
+    readOnlyHandling: macro
+    regularHandling: runtime
     summary: Up vector (used to interpret the `Lookatpos`).
   shortcuts:
   - lac

docs/_reference/operators/camera/orthoCamera.md

@@ -29,9 +29,13 @@ op:
     summary: Direction that the camera faces.
   - label: Position
     name: Campos
+    readOnlyHandling: macro
+    regularHandling: runtime
     summary: Position of the camera.
   - label: Rotate
     name: Rotate
+    readOnlyHandling: macro
+    regularHandling: runtime
     summary: Rotation of the camera view on the axis facing the camera.
   status: beta
   summary: An orthographic (non-perspective) camera, which can be used for flattened

docs/_reference/operators/camera/splitCamera.md

@@ -65,9 +65,13 @@ op:
       label: Grid
       name: grid
     name: Layout
+    readOnlyHandling: macro
+    regularHandling: macro
     summary: How to arrange the zones.
   - label: Rescale
     name: Rescale
+    readOnlyHandling: macro
+    regularHandling: macro
     summary: Whether to rescale each camera to fit each zone. When switched off, if
       using a grid, you will only see the top right corner of the first camera, the
       top left of the second, etc. When switched on, you see the full view that each

docs/_reference/operators/combine/blend.md

@@ -125,11 +125,15 @@ op:
     name: Enable
   - label: Blend
     name: Blend
+    readOnlyHandling: macro
+    regularHandling: runtime
     summary: Which input or combination of inputs to use. If this value is 0, the
       first connected input is used. 0.5 is half way between the first and second
       connected inputs, etc.
   - label: Use Last Input As Switch
     name: Usefield
+    readOnlyHandling: macro
+    regularHandling: macro
     summary: Whether to use the 4th input as a field to determine the blending, instead
       of using it as just another input.
   - label: Blend Source

docs/_reference/operators/combine/boundLimit.md

@@ -50,6 +50,8 @@ op:
     name: Enable
   - label: Margin
     name: Margin
+    readOnlyHandling: macro
+    regularHandling: runtime
   status: beta
 
 ---

docs/_reference/operators/combine/combineFields.md

@@ -196,6 +196,8 @@ op:
     summary: What operation to use to combine the field values.
   - label: Swap Order
     name: Swaporder
+    readOnlyHandling: macro
+    regularHandling: runtime
     summary: Swaps the two inputs. This is only relevant for some of the `Operation`
       values.
   - label: Optimize

docs/_reference/operators/combine/compositeFields.md

@@ -141,8 +141,12 @@ op:
     name: Blendmode
   - label: Blend
     name: Blend
+    readOnlyHandling: macro
+    regularHandling: runtime
   - label: Swap Inputs
     name: Swapinputs
+    readOnlyHandling: macro
+    regularHandling: runtime
   - label: Blend Field
     name: Blendfield
   summary: Combines two vector fields using color compositing.

docs/_reference/operators/combine/edgeCombine.md

@@ -101,11 +101,17 @@ op:
     name: Combine
   - label: Swap Inputs
     name: Swapinputs
+    readOnlyHandling: macro
+    regularHandling: runtime
   - label: Radius
     name: Radius
+    readOnlyHandling: macro
+    regularHandling: runtime
     summary: Width of the edge overlap area.
   - label: Depth
     name: Depth
+    readOnlyHandling: macro
+    regularHandling: runtime
     summary: Depth of the groove / tongue.
   summary: Combines two SDFs in ways that use the intersection areas.
   thumb: assets/images/reference/operators/combine/edgeCombine_thumb.png

docs/_reference/operators/combine/iterationSwitch.md

@@ -171,6 +171,8 @@ op:
     - label: W
       name: w
     name: Iterationpart
+    readOnlyHandling: constant
+    regularHandling: constant
     summary: Which component of the iteration vector to use. In most cases this should
       be X.
   - label: Extend
@@ -185,6 +187,8 @@ op:
       label: Zig-Zag
       name: zigzag
     name: Extend
+    readOnlyHandling: constant
+    regularHandling: constant
     summary: 'How to handle iteration values outside the 0..(N-1) range. '
   summary: Switches between inputs based on the iteration value provided by a downstream
     operator.

docs/_reference/operators/combine/layoutGrid.md

@@ -124,12 +124,18 @@ op:
     - label: XY
       name: z
     name: Axis
+    readOnlyHandling: constant
+    regularHandling: runtime
     summary: The plane along which to arrange the cells.
   - label: Size
     name: Size
+    readOnlyHandling: macro
+    regularHandling: runtime
     summary: The size of the cells
   - label: Pre Scale
     name: Prescale
+    readOnlyHandling: macro
+    regularHandling: runtime
     summary: Scales the inputs within their cells.
   summary: Slices space into a grid, and places each input in a separate cell.
   thumb: assets/images/reference/operators/combine/layoutGrid_thumb.png

docs/_reference/operators/combine/mergeFields.md

@@ -113,6 +113,8 @@ op:
     - label: Input 4
       name: input4
     name: Sourcex
+    readOnlyHandling: macro
+    regularHandling: macro
   - label: Y Source
     menuOptions:
     - label: Zero
@@ -128,6 +130,8 @@ op:
     - label: Input 4
       name: input4
     name: Sourcey
+    readOnlyHandling: macro
+    regularHandling: macro
   - label: Z Source
     menuOptions:
     - label: Zero
@@ -143,6 +147,8 @@ op:
     - label: Input 4
       name: input4
     name: Sourcez
+    readOnlyHandling: macro
+    regularHandling: macro
   - label: W Source
     menuOptions:
     - label: Zero
@@ -158,6 +164,8 @@ op:
     - label: Input 4
       name: input4
     name: Sourcew
+    readOnlyHandling: macro
+    regularHandling: macro
   summary: Merges multiple vector fields, using different fields for each vector part.
 
 ---

docs/_reference/operators/combine/shapedCombine.md

@@ -73,6 +73,8 @@ op:
     name: Enable
   - label: Radius
     name: Radius
+    readOnlyHandling: macro
+    regularHandling: runtime
   status: beta
   summary: Combine two SDFs, using a 2D SDF to shape the blending region.
 

docs/_reference/operators/combine/simpleDiff.md

@@ -62,6 +62,8 @@ op:
     name: Enable
   - label: Swap Order
     name: Swaporder
+    readOnlyHandling: macro
+    regularHandling: runtime
     summary: Swaps the two inputs, subtracting the first from the second.
   summary: Combines two SDFs using the difference operator.
   thumb: assets/images/reference/operators/combine/simpleDiff_thumb.png

docs/_reference/operators/combine/switch.md

@@ -224,9 +224,13 @@ op:
     name: Enable
   - label: Source
     name: Source
+    readOnlyHandling: macro
+    regularHandling: runtime
     summary: When 0, the first source is used, 1 for the second, etc.
   - label: Blend Between Inputs
     name: Blend
+    readOnlyHandling: constant
+    regularHandling: constant
   - label: Index Field
     name: Indexfield
   - label: Index Mode

docs/_reference/operators/combine/triPlanarCombine.md

@@ -100,10 +100,16 @@ op:
   parameters:
   - label: Translate
     name: Translate
+    readOnlyHandling: macro
+    regularHandling: runtime
   - label: Scale
     name: Scale
+    readOnlyHandling: macro
+    regularHandling: runtime
   - label: Use Normals
     name: Usenormals
+    readOnlyHandling: constant
+    regularHandling: runtime
     summary: Modifies the amount of each field that's used based on how directly the
       surface normals are facing that plane. For example, the XY field is used most
       on parts that are facing forwards or backwards.

docs/_reference/operators/convert/coordTo2D.md

@@ -55,8 +55,12 @@ op:
     - label: ZX Plane
       name: zx
     name: Mode
+    readOnlyHandling: macro
+    regularHandling: macro
   - label: Plane Offset
     name: Planeoffset
+    readOnlyHandling: macro
+    regularHandling: runtime
   - label: Part X
     menuOptions:
     - label: X

docs/_reference/operators/convert/crossSection.md

@@ -79,6 +79,8 @@ op:
     name: Axes
   - label: Offset
     name: Offset
+    readOnlyHandling: macro
+    regularHandling: runtime
     summary: Offsets the plane or axis where the input is sampled.
   summary: Takes a 3D (or 2D) operator and take a cross section of it across a plane
     or a single axis.