Skip to content

Commit

Permalink
update generated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
t3kt committed Feb 3, 2024
1 parent 0990ccf commit 2a879e3
Show file tree
Hide file tree
Showing 305 changed files with 2,630 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/_reference/operators/camera/basicCamera.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 2 additions & 0 deletions docs/_reference/operators/camera/fieldCamera.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ op:
parameters:
- label: Position
name: Campos
readOnlyHandling: macro
regularHandling: runtime
summary: Position of the camera.
status: beta

Expand Down
12 changes: 12 additions & 0 deletions docs/_reference/operators/camera/fisheyeCamera.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 10 additions & 0 deletions docs/_reference/operators/camera/lookAtCamera.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions docs/_reference/operators/camera/orthoCamera.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions docs/_reference/operators/camera/splitCamera.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions docs/_reference/operators/combine/blend.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/_reference/operators/combine/boundLimit.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ op:
name: Enable
- label: Margin
name: Margin
readOnlyHandling: macro
regularHandling: runtime
status: beta

---
2 changes: 2 additions & 0 deletions docs/_reference/operators/combine/combineFields.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions docs/_reference/operators/combine/compositeFields.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 6 additions & 0 deletions docs/_reference/operators/combine/edgeCombine.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions docs/_reference/operators/combine/iterationSwitch.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
6 changes: 6 additions & 0 deletions docs/_reference/operators/combine/layoutGrid.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 8 additions & 0 deletions docs/_reference/operators/combine/mergeFields.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,8 @@ op:
- label: Input 4
name: input4
name: Sourcex
readOnlyHandling: macro
regularHandling: macro
- label: Y Source
menuOptions:
- label: Zero
Expand All @@ -128,6 +130,8 @@ op:
- label: Input 4
name: input4
name: Sourcey
readOnlyHandling: macro
regularHandling: macro
- label: Z Source
menuOptions:
- label: Zero
Expand All @@ -143,6 +147,8 @@ op:
- label: Input 4
name: input4
name: Sourcez
readOnlyHandling: macro
regularHandling: macro
- label: W Source
menuOptions:
- label: Zero
Expand All @@ -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.

---
Expand Down
2 changes: 2 additions & 0 deletions docs/_reference/operators/combine/shapedCombine.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 2 additions & 0 deletions docs/_reference/operators/combine/simpleDiff.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions docs/_reference/operators/combine/switch.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions docs/_reference/operators/combine/triPlanarCombine.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 4 additions & 0 deletions docs/_reference/operators/convert/coordTo2D.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/_reference/operators/convert/crossSection.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
12 changes: 12 additions & 0 deletions docs/_reference/operators/convert/extrude.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,14 +70,22 @@ op:
- label: Z
name: z
name: Axis
readOnlyHandling: constant
regularHandling: constant
- label: Infinite Height
name: Infiniteheight
readOnlyHandling: constant
regularHandling: constant
summary: Whether the shape should be infinitely thick along the axis.
- label: Height
name: Height
readOnlyHandling: macro
regularHandling: runtime
summary: Height of the extruded shape.
- label: Offset
name: Offset
readOnlyHandling: macro
regularHandling: runtime
summary: Moves the extruded shape up and down along the axis.
- label: UV Mode
menuOptions:
Expand All @@ -86,13 +94,17 @@ op:
- label: Depth
name: depth
name: Uvmode
readOnlyHandling: constant
regularHandling: constant
- label: Iteration Type
menuOptions:
- label: None
name: none
- label: Ratio
name: ratio
name: Iterationtype
readOnlyHandling: constant
regularHandling: constant
- label: Optimize
name: Optimize
shortcuts:
Expand Down
4 changes: 4 additions & 0 deletions docs/_reference/operators/convert/extrudeLine.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,12 @@ op:
parameters:
- label: Point 1
name: Point1
readOnlyHandling: macro
regularHandling: runtime
- label: Point 2
name: Point2
readOnlyHandling: macro
regularHandling: runtime
status: beta
summary: Extrudes a 2D SDF cross-section into a 3D volume, like the extrude operator,
but between two points.
Expand Down
Loading

0 comments on commit 2a879e3

Please sign in to comment.