From d2a19bc15eb79c0967d2c7a61ad405c7cb880de0 Mon Sep 17 00:00:00 2001 From: t3kt Date: Thu, 22 Jun 2023 16:06:39 -0700 Subject: [PATCH] update generated docs --- docs/_data/toolkit.yaml | 2 +- docs/_reference/operators/combine/index.md | 1 + .../operators/combine/triPlanarCombine.md | 14 +++ .../operators/convert/vectorToFloat.md | 6 ++ .../operators/field/colorRampField.md | 94 +++++++++++++++---- docs/_reference/operators/field/rampField.md | 15 ++- docs/_reference/operators/field/stepField.md | 13 +++ .../operators/filter/adjustColor.md | 6 +- docs/_reference/operators/filter/index.md | 3 +- .../_reference/operators/filter/spiralZoom.md | 5 + docs/_reference/operators/light/axisLight.md | 8 ++ docs/_reference/operators/light/pointLight.md | 20 ++-- .../operators/material/hologramContrib.md | 41 ++++++++ docs/_reference/operators/material/index.md | 2 + .../operators/output/raymarchRender3D.md | 4 + docs/_reference/operators/pattern/index.md | 2 + .../operators/pattern/knitPattern.md | 40 ++++++++ docs/_reference/operators/sdf/archSdf.md | 79 ++++++++++++++++ docs/_reference/operators/sdf/crossSdf.md | 23 +++++ docs/_reference/operators/sdf/helixSdf.md | 14 +++ docs/_reference/operators/sdf2d/archSdf2d.md | 33 +++++++ docs/_reference/operators/sdf2d/coolSSdf2d.md | 15 +++ docs/_reference/operators/sdf2d/index.md | 3 + .../operators/sdf2d/polygonSdf2d.md | 17 ++++ .../operators/sdf2d/rectangleSdf.md | 1 - 25 files changed, 430 insertions(+), 31 deletions(-) create mode 100644 docs/_reference/operators/material/hologramContrib.md create mode 100644 docs/_reference/operators/pattern/knitPattern.md create mode 100644 docs/_reference/operators/sdf2d/archSdf2d.md create mode 100644 docs/_reference/operators/sdf2d/coolSSdf2d.md diff --git a/docs/_data/toolkit.yaml b/docs/_data/toolkit.yaml index 6a60bf1e3..a5ef23767 100644 --- a/docs/_data/toolkit.yaml +++ b/docs/_data/toolkit.yaml @@ -1 +1 @@ -toolkitVersion: '0.34' +toolkitVersion: '0.35' diff --git a/docs/_reference/operators/combine/index.md b/docs/_reference/operators/combine/index.md index 3e3d645da..4bcbc0630 100644 --- a/docs/_reference/operators/combine/index.md +++ b/docs/_reference/operators/combine/index.md @@ -65,6 +65,7 @@ cat: allowing for fast switching. - name: triPlanarCombine status: beta + summary: Combines three 2D fields based on vectors like surface normals. summary: 'Operators that take two or more inputs and combine them into a single output.' diff --git a/docs/_reference/operators/combine/triPlanarCombine.md b/docs/_reference/operators/combine/triPlanarCombine.md index 38cc94657..c33a25bf2 100644 --- a/docs/_reference/operators/combine/triPlanarCombine.md +++ b/docs/_reference/operators/combine/triPlanarCombine.md @@ -23,6 +23,9 @@ op: required: true returnTypes: - vec4 + summary: Alternative way to provide the coordinates used by the fields rather + than just using the position in space. Each input field gets two of the axes + of the coordinates provided (e.g. the XY field gets the x and y). - contextTypes: - Context - MaterialContext @@ -37,6 +40,9 @@ op: required: true returnTypes: - vec4 + summary: Field that provides the surface normals used to adjust the influence + of each plane. Typically this should be a `normalField` or a `variableReference` + that accesses a surface normal within a material. - contextTypes: - Context - MaterialContext @@ -88,6 +94,9 @@ op: name: Scale - label: Use Normals name: Usenormals + 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. - label: Blend Mode menuOptions: - label: Add Axes @@ -97,6 +106,7 @@ op: - label: Average Axes name: avg name: Blendmode + summary: How the values from each field are combined. - label: Return Type menuOptions: - label: Auto @@ -107,5 +117,9 @@ op: name: vec4 name: Returntype status: beta + summary: Combines three 2D fields based on vectors like surface normals. --- + + +Combines three 2D fields based on vectors like surface normals. \ No newline at end of file diff --git a/docs/_reference/operators/convert/vectorToFloat.md b/docs/_reference/operators/convert/vectorToFloat.md index f42d9befe..291f3570a 100644 --- a/docs/_reference/operators/convert/vectorToFloat.md +++ b/docs/_reference/operators/convert/vectorToFloat.md @@ -75,6 +75,12 @@ op: name: val - label: Luminance name: luma + - label: Sum(XY) + name: sumxy + - label: Sum(XYZ) + name: sumxyz + - label: Sum(XYZW) + name: sumxyzw name: Usepart summary: Which part of the vector to use for the float field. summary: Converts a vector value field to a float field using one part of the vector. diff --git a/docs/_reference/operators/field/colorRampField.md b/docs/_reference/operators/field/colorRampField.md index 2906cbfb8..add1ef2d3 100644 --- a/docs/_reference/operators/field/colorRampField.md +++ b/docs/_reference/operators/field/colorRampField.md @@ -26,6 +26,53 @@ op: returnTypes: - float - vec4 + - contextTypes: + - Context + - MaterialContext + - CameraContext + - LightContext + - RayContext + - ParticleContext + coordTypes: + - float + - vec2 + - vec3 + - vec4 + label: Point 1 Field + name: point1Field + returnTypes: + - float + - vec4 + - contextTypes: + - Context + - MaterialContext + - CameraContext + - LightContext + - RayContext + - ParticleContext + coordTypes: + - float + - vec2 + - vec3 + - vec4 + label: Point 2 Field + name: point2Field + returnTypes: + - float + - vec4 + - contextTypes: + - Context + - MaterialContext + - CameraContext + - LightContext + - RayContext + - ParticleContext + coordTypes: + - float + label: Easing Function + name: easingFunc + returnTypes: + - float keywords: - color - gradient @@ -35,17 +82,13 @@ op: parameters: - label: Enable name: Enable - - label: Coord Type + - label: Coordinate Mode menuOptions: - - label: Auto - name: auto - - label: 1D - name: float - - label: 2D - name: vec2 - - label: 3D - name: vec3 - name: Coordtype + - label: Axis + name: axis + - label: Endpoints + name: points + name: Coordmode - label: Axis menuOptions: - label: X @@ -57,16 +100,12 @@ op: - label: Distance From Origin name: dist name: Axis - - label: Color 1 - name: Color1 - - label: Alpha 1 - name: Alpha1 - - label: Color 2 - name: Color2 - - label: Alpha 2 - name: Alpha2 - label: Coordinate Range name: Range + - label: Point 1 + name: Point1 + - label: Point 2 + name: Point2 - label: Extend Mode menuOptions: - label: Hold @@ -78,6 +117,25 @@ op: - label: Mirror name: mirror name: Extendmode + - label: Color 1 + name: Color1 + - label: Alpha 1 + name: Alpha1 + - label: Color 2 + name: Color2 + - label: Alpha 2 + name: Alpha2 + - label: Coord Type + menuOptions: + - label: Auto + name: auto + - label: 1D + name: float + - label: 2D + name: vec2 + - label: 3D + name: vec3 + name: Coordtype summary: A vector field that maps an input field to values from a range of colors. thumb: assets/images/reference/operators/field/colorRampField_thumb.png diff --git a/docs/_reference/operators/field/rampField.md b/docs/_reference/operators/field/rampField.md index 880cfaeaa..fb05e9db6 100644 --- a/docs/_reference/operators/field/rampField.md +++ b/docs/_reference/operators/field/rampField.md @@ -41,7 +41,6 @@ op: - vec4 label: Point 1 Field name: point1Field - required: true returnTypes: - float - vec4 @@ -59,10 +58,22 @@ op: - vec4 label: Point 2 Field name: point2Field - required: true returnTypes: - float - vec4 + - contextTypes: + - Context + - MaterialContext + - CameraContext + - LightContext + - RayContext + - ParticleContext + coordTypes: + - float + label: Easing Function + name: easingFunc + returnTypes: + - float name: rampField opType: raytk.operators.field.rampField parameters: diff --git a/docs/_reference/operators/field/stepField.md b/docs/_reference/operators/field/stepField.md index 994d20a75..c0bc879bc 100644 --- a/docs/_reference/operators/field/stepField.md +++ b/docs/_reference/operators/field/stepField.md @@ -82,6 +82,19 @@ op: returnTypes: - float - vec4 + - contextTypes: + - Context + - MaterialContext + - CameraContext + - LightContext + - RayContext + - ParticleContext + coordTypes: + - float + label: Blend Function + name: blendFunction + returnTypes: + - float name: stepField opType: raytk.operators.field.stepField parameters: diff --git a/docs/_reference/operators/filter/adjustColor.md b/docs/_reference/operators/filter/adjustColor.md index a678e3811..02f6ce7e0 100644 --- a/docs/_reference/operators/filter/adjustColor.md +++ b/docs/_reference/operators/filter/adjustColor.md @@ -27,6 +27,7 @@ op: required: true returnTypes: - vec4 + - Sdf - contextTypes: - Context - MaterialContext @@ -114,12 +115,13 @@ op: name: Hueoffset - label: Gamma name: Gamma - summary: Adjust properties of color values. + summary: Adjust properties of color values, either directly on a field, or on the + assigned surface color of an Sdf result. thumb: assets/images/reference/operators/filter/adjustColor_thumb.png --- -Adjust properties of color values. +Adjust properties of color values, either directly on a field, or on the assigned surface color of an Sdf result. This is similar to Level TOP and HSV Adjust TOP. \ No newline at end of file diff --git a/docs/_reference/operators/filter/index.md b/docs/_reference/operators/filter/index.md index c394af39c..2d284ecb2 100644 --- a/docs/_reference/operators/filter/index.md +++ b/docs/_reference/operators/filter/index.md @@ -25,7 +25,8 @@ cat: - hue - saturation name: adjustColor - summary: Adjust properties of color values. + summary: Adjust properties of color values, either directly on a field, or on + the assigned surface color of an Sdf result. - keywords: - color - material diff --git a/docs/_reference/operators/filter/spiralZoom.md b/docs/_reference/operators/filter/spiralZoom.md index 85c4faf4e..67d620b22 100644 --- a/docs/_reference/operators/filter/spiralZoom.md +++ b/docs/_reference/operators/filter/spiralZoom.md @@ -125,6 +125,11 @@ op: that if this is not a whole integer, there will be a break in the spiral. summary: Transforms space using a logarithmic spiral. thumb: assets/images/reference/operators/filter/spiralZoom_thumb.png + variables: + - label: logdist + name: logdist + - label: dist + name: dist --- diff --git a/docs/_reference/operators/light/axisLight.md b/docs/_reference/operators/light/axisLight.md index 3be537b3a..ff0cdbf2a 100644 --- a/docs/_reference/operators/light/axisLight.md +++ b/docs/_reference/operators/light/axisLight.md @@ -9,6 +9,14 @@ redirect_from: op: category: light inputs: + - contextTypes: + - LightContext + coordTypes: + - vec3 + label: Position Field + name: positionField + returnTypes: + - vec4 - contextTypes: - LightContext coordTypes: diff --git a/docs/_reference/operators/light/pointLight.md b/docs/_reference/operators/light/pointLight.md index e713de518..620c2afcd 100644 --- a/docs/_reference/operators/light/pointLight.md +++ b/docs/_reference/operators/light/pointLight.md @@ -13,10 +13,9 @@ op: - LightContext coordTypes: - vec3 - label: Color Field - name: colorField + label: Position Field + name: positionField returnTypes: - - float - vec4 summary: Optional field that can control the color of the light based on the position of surface hits where it is being applied. The resulting color is multiplied @@ -24,15 +23,24 @@ op: - contextTypes: - LightContext coordTypes: - - float - label: Attenuation Field - name: attenuationField + - vec3 + label: Color Field + name: colorField returnTypes: - float - vec4 summary: Optional field/function that controls the slope and coloration of the attentuation rolloff is shaped. It can be used to make the light shift from one color to another, or to control the sharpness of the rolloff. + - contextTypes: + - LightContext + coordTypes: + - float + label: Attenuation Field + name: attenuationField + returnTypes: + - float + - vec4 name: pointLight opType: raytk.operators.light.pointLight parameters: diff --git a/docs/_reference/operators/material/hologramContrib.md b/docs/_reference/operators/material/hologramContrib.md new file mode 100644 index 000000000..405b005cd --- /dev/null +++ b/docs/_reference/operators/material/hologramContrib.md @@ -0,0 +1,41 @@ +--- +layout: operator +title: hologramContrib +parent: Material Operators +grand_parent: Operators +permalink: /reference/operators/material/hologramContrib +redirect_from: + - /reference/opType/raytk.operators.material.hologramContrib/ +op: + category: material + inputs: + - contextTypes: + - MaterialContext + coordTypes: + - vec3 + label: Color Field + name: colorField + returnTypes: + - float + - vec4 + name: hologramContrib + opType: raytk.operators.material.hologramContrib + parameters: + - label: Enable + name: Enable + - label: Iterations + name: Iterations + - label: Step Distance + name: Step + - label: Period + name: Period + - label: Phase + name: Phase + status: beta + variables: + - label: step + name: step + - label: normstep + name: normstep + +--- diff --git a/docs/_reference/operators/material/index.md b/docs/_reference/operators/material/index.md index edef2114f..393abe08c 100644 --- a/docs/_reference/operators/material/index.md +++ b/docs/_reference/operators/material/index.md @@ -37,6 +37,8 @@ cat: the color.' - name: goochShadingContrib summary: A material element that uses the Gooch shading model. + - name: hologramContrib + status: beta - name: iridescenceContrib status: beta summary: Shading element that produces a rainbow pattern around the edges of shapes, diff --git a/docs/_reference/operators/output/raymarchRender3D.md b/docs/_reference/operators/output/raymarchRender3D.md index fa07e2e23..7e66ae84e 100644 --- a/docs/_reference/operators/output/raymarchRender3D.md +++ b/docs/_reference/operators/output/raymarchRender3D.md @@ -277,6 +277,10 @@ op: name: Enablesecondaryraycast - label: Secondary Ray Cast name: Secondaryraycast + - label: Attributes + name: Headerattrs + - label: Attribute Definitions + name: Attributedefinitions - label: Customize Shader Config name: Customizeshaderconfig - label: Enable UV Output diff --git a/docs/_reference/operators/pattern/index.md b/docs/_reference/operators/pattern/index.md index 58b97bda9..55e3dc310 100644 --- a/docs/_reference/operators/pattern/index.md +++ b/docs/_reference/operators/pattern/index.md @@ -19,6 +19,8 @@ cat: - name: hexagonalGridPattern - name: hexagonalTruchetPattern - name: hexagonalWeavePattern + - name: knitPattern + status: beta - name: rosettePattern - name: snubQuadrilePattern status: beta diff --git a/docs/_reference/operators/pattern/knitPattern.md b/docs/_reference/operators/pattern/knitPattern.md new file mode 100644 index 000000000..cb2fadac0 --- /dev/null +++ b/docs/_reference/operators/pattern/knitPattern.md @@ -0,0 +1,40 @@ +--- +layout: operator +title: knitPattern +parent: Pattern Operators +grand_parent: Operators +permalink: /reference/operators/pattern/knitPattern +redirect_from: + - /reference/opType/raytk.operators.pattern.knitPattern/ +op: + category: pattern + inputs: + - contextTypes: + - Context + - MaterialContext + - CameraContext + - LightContext + - RayContext + - ParticleContext + coordTypes: + - vec2 + - vec3 + label: Coordinate Field + name: coordField + returnTypes: + - vec4 + name: knitPattern + opType: raytk.operators.pattern.knitPattern + parameters: + - label: Translate + name: Translate + - label: Size + name: Size + - label: Texture Amount + name: Texamount + - label: Texture Density + name: Texdensity + status: beta + thumb: assets/images/reference/operators/pattern/knitPattern_thumb.png + +--- diff --git a/docs/_reference/operators/sdf/archSdf.md b/docs/_reference/operators/sdf/archSdf.md index 48bf784e6..24423fd3f 100644 --- a/docs/_reference/operators/sdf/archSdf.md +++ b/docs/_reference/operators/sdf/archSdf.md @@ -8,6 +8,85 @@ redirect_from: - /reference/opType/raytk.operators.sdf.archSdf/ op: category: sdf + inputs: + - contextTypes: + - Context + - MaterialContext + - CameraContext + - LightContext + - RayContext + - ParticleContext + coordTypes: + - vec3 + label: Height Field + name: heightField + returnTypes: + - float + - contextTypes: + - Context + - MaterialContext + - CameraContext + - LightContext + - RayContext + - ParticleContext + coordTypes: + - vec3 + label: Width Field + name: widthField + returnTypes: + - float + - contextTypes: + - Context + - MaterialContext + - CameraContext + - LightContext + - RayContext + - ParticleContext + coordTypes: + - vec3 + label: Rounding Field + name: roundingField + returnTypes: + - float + - contextTypes: + - Context + - MaterialContext + - CameraContext + - LightContext + - RayContext + - ParticleContext + coordTypes: + - vec3 + label: Frame Thickness Field + name: frameThicknessField + returnTypes: + - float + - contextTypes: + - Context + - MaterialContext + - CameraContext + - LightContext + - RayContext + - ParticleContext + coordTypes: + - vec3 + label: Frame Depth Field + name: frameDepthField + returnTypes: + - float + - contextTypes: + - Context + - MaterialContext + - CameraContext + - LightContext + - RayContext + - ParticleContext + coordTypes: + - vec3 + label: Panel Depth Field + name: panelDepthField + returnTypes: + - float name: archSdf opType: raytk.operators.sdf.archSdf parameters: diff --git a/docs/_reference/operators/sdf/crossSdf.md b/docs/_reference/operators/sdf/crossSdf.md index 2dc5bcc94..7165b0cda 100644 --- a/docs/_reference/operators/sdf/crossSdf.md +++ b/docs/_reference/operators/sdf/crossSdf.md @@ -36,6 +36,20 @@ op: name: smoothRadiusField returnTypes: - float + - contextTypes: + - Context + - MaterialContext + - CameraContext + - LightContext + - RayContext + - ParticleContext + coordTypes: + - vec3 + label: Length Field + name: lengthField + returnTypes: + - float + - vec4 name: crossSdf opType: raytk.operators.sdf.crossSdf parameters: @@ -59,6 +73,15 @@ op: - label: ZX name: zx name: Axes + - label: Shape + menuOptions: + - label: Infinite + name: infinite + - label: Limited XYZ + name: limitxyz + name: Shape + - label: Length + name: Length summary: An SDF for a 3D cross of infinite length along each axis. thumb: assets/images/reference/operators/sdf/crossSdf_thumb.png diff --git a/docs/_reference/operators/sdf/helixSdf.md b/docs/_reference/operators/sdf/helixSdf.md index eaacfac38..afb48295c 100644 --- a/docs/_reference/operators/sdf/helixSdf.md +++ b/docs/_reference/operators/sdf/helixSdf.md @@ -44,6 +44,20 @@ op: summary: Field used to multiply the `Thickness` parameter. If it uses 1D coordinates, it is provided the position along the axis. If it uses 3D coordinates, it uses the absolute position. + - contextTypes: + - Context + - MaterialContext + - CameraContext + - LightContext + - RayContext + - ParticleContext + coordTypes: + - float + - vec3 + label: Spread Field + name: spreadField + returnTypes: + - float - contextTypes: - Context - MaterialContext diff --git a/docs/_reference/operators/sdf2d/archSdf2d.md b/docs/_reference/operators/sdf2d/archSdf2d.md new file mode 100644 index 000000000..e748a4e39 --- /dev/null +++ b/docs/_reference/operators/sdf2d/archSdf2d.md @@ -0,0 +1,33 @@ +--- +layout: operator +title: archSdf2d +parent: Sdf2d Operators +grand_parent: Operators +permalink: /reference/operators/sdf2d/archSdf2d +redirect_from: + - /reference/opType/raytk.operators.sdf2d.archSdf2d/ +op: + category: sdf2d + inputs: + - contextTypes: + - Context + - MaterialContext + - CameraContext + - LightContext + - RayContext + - ParticleContext + coordTypes: + - vec2 + label: Scale Field + name: scaleField + returnTypes: + - vec4 + name: archSdf2d + opType: raytk.operators.sdf2d.archSdf2d + parameters: + - label: Scale + name: Scale + status: beta + thumb: assets/images/reference/operators/sdf2d/archSdf2d_thumb.png + +--- diff --git a/docs/_reference/operators/sdf2d/coolSSdf2d.md b/docs/_reference/operators/sdf2d/coolSSdf2d.md new file mode 100644 index 000000000..c81c81158 --- /dev/null +++ b/docs/_reference/operators/sdf2d/coolSSdf2d.md @@ -0,0 +1,15 @@ +--- +layout: operator +title: coolSSdf2d +parent: Sdf2d Operators +grand_parent: Operators +permalink: /reference/operators/sdf2d/coolSSdf2d +redirect_from: + - /reference/opType/raytk.operators.sdf2d.coolSSdf2d/ +op: + category: sdf2d + name: coolSSdf2d + opType: raytk.operators.sdf2d.coolSSdf2d + thumb: assets/images/reference/operators/sdf2d/coolSSdf2d_thumb.png + +--- diff --git a/docs/_reference/operators/sdf2d/index.md b/docs/_reference/operators/sdf2d/index.md index 310a33d4c..a45bdf335 100644 --- a/docs/_reference/operators/sdf2d/index.md +++ b/docs/_reference/operators/sdf2d/index.md @@ -15,6 +15,8 @@ cat: - name: arbitraryPolygonSdf2d status: beta - name: arcSdf2d + - name: archSdf2d + status: beta - name: arrowSdf2d - keywords: - bezier @@ -28,6 +30,7 @@ cat: summary: 2D circle SDF. - name: circleWaveSdf2d status: beta + - name: coolSSdf2d - name: cornerSdf2d summary: 2D SDF for an infinite corner, like an infinite square positioned by one corner. diff --git a/docs/_reference/operators/sdf2d/polygonSdf2d.md b/docs/_reference/operators/sdf2d/polygonSdf2d.md index ae5f65344..115025b02 100644 --- a/docs/_reference/operators/sdf2d/polygonSdf2d.md +++ b/docs/_reference/operators/sdf2d/polygonSdf2d.md @@ -22,6 +22,19 @@ op: name: radiusField returnTypes: - float + - contextTypes: + - Context + - MaterialContext + - CameraContext + - LightContext + - RayContext + - ParticleContext + coordTypes: + - vec2 + label: Sides Field + name: sidesField + returnTypes: + - float name: polygonSdf2d opType: raytk.operators.sdf2d.polygonSdf2d parameters: @@ -33,10 +46,14 @@ op: name: hexagon - label: Octogon name: octogon + - label: Custom + name: custom name: Shape - label: Radius name: Radius summary: The distance from the center to each edge. + - label: Sides + name: Sides summary: SDF for several types of 2D polygons. thumb: assets/images/reference/operators/sdf2d/polygonSdf2d_thumb.png diff --git a/docs/_reference/operators/sdf2d/rectangleSdf.md b/docs/_reference/operators/sdf2d/rectangleSdf.md index 0d5820e03..6a4f3ae33 100644 --- a/docs/_reference/operators/sdf2d/rectangleSdf.md +++ b/docs/_reference/operators/sdf2d/rectangleSdf.md @@ -35,7 +35,6 @@ op: label: Translate Field name: translateField returnTypes: - - float - vec4 name: rectangleSdf opType: raytk.operators.sdf2d.rectangleSdf