Merge pull request #155 from sideeffects/docs

Merge branch 'docs' into Development

Author: mikelyndon-sesi

otls/gamedev_curve_branches.hda/gamedev_8_8Sop_1sop__curve__branches/Contents.dir/Contents.mime

@@ -3,7 +3,7 @@
 {
     name	gamedev::sop_curve_branches
     script	gamedev::sop_curve_branches
-    label	"GameDev Simple L System"
+    label	"GameDev Curve Branches"
 
     help {
 	""
@@ -20,6 +20,7 @@
         type    color
         size    3
         default { "0" "1" "0" }
+        help    "Color of the generated branches."
         range   { 0 1 }
         parmtag { "autoscope" "0000000000000000" }
     }
@@ -29,6 +30,7 @@
         type    float
         joinnext
         default { "0" }
+        help    "Minimum distance along input curve(s) where branches can start growing. A value of 0.5 will mean branches can only grow from halfway down the input curve."
         range   { 0! 1! }
         parmtag { "autoscope" "0000000000000000" }
     }
@@ -37,6 +39,7 @@
         label   "Finish"
         type    float
         default { "1" }
+        help    "Maximum distance along input curve(s) where branches can start growing. A value of 0.7 will mean branches will stop being generated at 70% of the original curve input."
         range   { 0! 1! }
         parmtag { "autoscope" "0000000000000000" }
     }
@@ -46,6 +49,7 @@
         type    integer
         joinnext
         default { "4" }
+        help    "Number of branches to generate per input curve."
         range   { 1 100 }
         parmtag { "autoscope" "0000000000000000" }
     }
@@ -54,6 +58,7 @@
         label   "Variation +-"
         type    integer
         default { "0" }
+        help    "Add randomness to the amount of child curves generated per input curve."
         range   { 1 100 }
         parmtag { "autoscope" "0000000000000000" }
     }
@@ -63,6 +68,7 @@
         type    float
         joinnext
         default { "0.2" }
+        help    "Length of the generated branches."
         range   { 0 10 }
         parmtag { "autoscope" "0000000000000000" }
     }
@@ -71,6 +77,7 @@
         label   "Variation +- "
         type    float
         default { "0" }
+        help    "Length variation per generated branch."
         range   { 0 10 }
         parmtag { "autoscope" "0000000000000000" }
     }
@@ -80,27 +87,32 @@
         type    float
         joinnext
         default { "3" }
+        help    "Offset added to Y component of branch direction vector. A value of 0 will make branches grow perpendicular to the input curves."
         range   { -100 100 }
+        parmtag { "autoscope" "0000000000000000" }
     }
     parm {
         name    "vertical_offset_variation"
         label   "Variation +-"
         type    float
         default { "0" }
+        help    "Amount of random offset of the vertical offset."
         range   { -100 100 }
     }
     parm {
         name    "mirror_x"
         label   "Mirror X "
         type    toggle
         default { "0" }
+        help    "Duplicate "
     }
     parm {
         name    "spread"
         label   "Spread"
         type    float
         joinnext
         default { "1" }
+        help    "Amount that branches twist around the input curves. A value of 0 means all branches will stay on the same plane (relative to the input curve), low spread values will spiral branches around the input curves, high spread values look more organic and chaotic."
         range   { 0 1 }
         parmtag { "autoscope" "0000000000000000" }
     }
@@ -117,18 +129,21 @@
         label   "Curl"
         type    float
         default { "0" }
+        help    "Apply a curl effect to the branches, approximating the look of vines and organic plant shapes."
         range   { -1 1 }
         parmtag { "autoscope" "0000000000000000" }
     }
     groupsimple {
         name    "folder0"
         label   "Noise"
+        grouptag { "group_type" "simple" }
 
         parm {
             name    "noise_intensity"
             label   "Intensity"
             type    ramp_flt
             default { "2" }
+            help    "Control where noise gets applied along the length of the branch. The left side of the ramp represents the start of the branc, the right side represents the end."
             range   { 1! 10 }
             parmtag { "autoscope" "0000000000000000" }
             parmtag { "rampfloatdefault" "1pos ( 0 ) 1value ( 0 ) 1interp ( linear ) 2pos ( 0.55176931619644165 ) 2value ( 0.63333332538604736 ) 2interp ( linear )" }
@@ -138,6 +153,7 @@
             label   "Amplitude"
             type    float
             default { "0.05" }
+            help    "Amplitude of noise, multiplied against the Intensity ramp."
             range   { -1 1 }
             parmtag { "autoscope" "0000000000000000" }
             parmtag { "parmvop" "1" }
@@ -149,6 +165,7 @@
             type    float
             size    3
             default { "20" "20" "20" }
+            help    "Frequency of the noise."
             range   { 0 10 }
             parmtag { "autoscope" "0000000000000000" }
             parmtag { "parmvop" "1" }
@@ -160,6 +177,7 @@
             type    float
             size    3
             default { "0" "0" "0" }
+            help    "Offset of noise."
             range   { 0 10 }
             parmtag { "autoscope" "0000000000000000" }
             parmtag { "parmvop" "1" }

otls/gamedev_curve_branches.hda/gamedev_8_8Sop_1sop__curve__branches/DialogScript

@@ -1,7 +1,7 @@
 {
 	"OnCreated/Cursor":{
 		"type":"intarray",
-		"value":[5,25]
+		"value":[1,1]
 	},
 	"OnCreated/IsExpr":{
 		"type":"bool",
@@ -18,5 +18,25 @@
 	"OnCreated/Source":{
 		"type":"string",
 		"value":""
+	},
+	"branch_v02.gif/Cursor":{
+		"type":"intarray",
+		"value":[0,0]
+	},
+	"branch_v02.gif/IsExpr":{
+		"type":"bool",
+		"value":false
+	},
+	"branch_v02.gif/IsPython":{
+		"type":"bool",
+		"value":false
+	},
+	"branch_v02.gif/IsScript":{
+		"type":"bool",
+		"value":false
+	},
+	"branch_v02.gif/Source":{
+		"type":"string",
+		"value":"C:/Users/139002/Pictures/branch_v02.gif"
 	}
 }

otls/gamedev_curve_branches.hda/gamedev_8_8Sop_1sop__curve__branches/ExtraFileOptions

@@ -0,0 +1,46 @@
+= GameDev Curve Branches =
+
+#type: node
+#context: sop
+#internal: gamedev::sop_curve_branches
+#icon: 
+#tags: tech, model
+
+""" Scatters curves over curves, with many intuitive controls to go from clean geometric branches to organic vines. Duplicates of this sop can be chained together for recursive growth, approximating the look of L-Systems but much more controllable. """
+
+:video:
+    #src:opdef:.?curvebranchv02.mp4
+
+@parameters
+    Color:
+        Color of the generated branches.
+    Start:
+        Minimum distance along input curve(s) where branches can start growing. A value of 0.5 will mean branches can only grow from halfway down the input curve.
+    Finish:
+        Maximum distance along input curve(s) where branches can start growing. A value of 0.7 will mean branches will stop being generated at 70% of the original curve input.
+    Number of Children:
+        Number of branches to generate per input curve.
+    Variation +-:
+        Amount of random offset of the vertical offset.
+    Length:
+        Length of the generated branches.
+    Variation +- :
+        Length variation per generated branch.
+    Vertical Offset:
+        Offset added to Y component of branch direction vector. A value of 0 will make branches grow perpendicular to the input curves.
+    Mirror X :
+        Duplicate 
+    Spread:
+        Amount that branches twist around the input curves. A value of 0 means all branches will stay on the same plane (relative to the input curve), low spread values will spiral branches around the input curves, high spread values look more organic and chaotic.
+    Curl:
+        Apply a curl effect to the branches, approximating the look of vines and organic plant shapes.
+    == Noise ==
+    Intensity:
+        Control where noise gets applied along the length of the branch. The left side of the ramp represents the start of the branc, the right side represents the end.
+    Amplitude:
+        Amplitude of noise, multiplied against the Intensity ramp.
+    Frequency:
+        Frequency of the noise.
+    Offset:
+        Offset of noise.
+    

otls/gamedev_curve_branches.hda/gamedev_8_8Sop_1sop__curve__branches/Help

@@ -9,3 +9,5 @@ Contents.gz	Contents.gz
 IconSVG	IconSVG
 OnCreated	OnCreated
 ExtraFileOptions	ExtraFileOptions
+branch__v02.gif	branch_v02.gif
+curvebranchv02.mp4	curvebranchv02.mp4

otls/gamedev_curve_branches.hda/gamedev_8_8Sop_1sop__curve__branches/Sections.list

@@ -19,6 +19,7 @@
         label   "Max Edge Angle"
         type    angle
         default { "0" }
+        help    "Threshold of 'flatness'. 0 means edges have to be perfectly flat, higher numbers will find more edges and dissolve them."
         range   { 0 360 }
         parmtag { "autoscope" "0000000000000000" }
     }

otls/gamedev_curve_branches.hda/gamedev_8_8Sop_1sop__curve__branches/branch__v02.gif

@@ -0,0 +1,19 @@
+= GameDev Dissolve Flat Edges =
+
+#type: node
+#context: sop
+#internal: gamedev::sop_dissolve_flat_edges
+#icon: 
+#tags: tech, model
+
+""" Remove edges on flat surfaces. """
+
+:video:
+    #src:opdef:.?dissolveflat.mp4
+
+This hda will identify edges that are flat, and dissolve them. The default behavior is to only find perfectly flat edges. The max edge angle slider allows a threshold of 'flatness', so edges which are mostly flat can also be dissolved, or the threshold can be set higher to obtain different effects, say artisticly driven decimation.
+
+@parameters
+    Max Edge Angle:
+        Threshold of 'flatness'. 0 means edges have to be perfectly flat, higher numbers will find more edges and dissolve them.
+    

otls/gamedev_curve_branches.hda/gamedev_8_8Sop_1sop__curve__branches/curvebranchv02.mp4

@@ -9,3 +9,4 @@ Contents.gz	Contents.gz
 IconSVG	IconSVG
 OnCreated	OnCreated
 ExtraFileOptions	ExtraFileOptions
+dissolveflat.mp4	dissolveflat.mp4