Skip to content

Commit

Permalink
Merge pull request #371 from nudibranchrecords/release/v0.6.0
Browse files Browse the repository at this point in the history
Release/v0.6.0
  • Loading branch information
funwithtriangles authored Mar 3, 2020
2 parents 1baf718 + b48a6d9 commit c720e5a
Show file tree
Hide file tree
Showing 37 changed files with 223 additions and 135 deletions.
3 changes: 2 additions & 1 deletion .eslintrc
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
"object-curly-spacing" : [2, "always"],
"no-var" : 2,
"comma-dangle" : [2, "always-multiline"],
"no-console" : [2, { "allow": ["warn", "error"] }]
"no-console" : [2, { "allow": ["warn", "error"] }],
"no-unused-expressions": 2
}
}
8 changes: 0 additions & 8 deletions docs/dev/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -317,14 +317,6 @@ module.exports = Bloom
### Other examples
There are plenty of other examples that can be found in the [example sketches folder](../../example-projects).

### Global postprocessing
By default, any post processing will only affect the scene that sketch is in. This means that fading the scene out on the crossfader will also fade out any post processing effects you have in that scene. However, by checking "Global Post Processing" enabled under the scene settings, the effect will now work across all scenes. An icon will appear on the scene thumbnail if this setting is enabled. The scene does not need to be added to any channel, `update` will always be running with this setting on.

As a convention, it makes sense to have a post processing scene, with post processing related sketches added to it. This scene does not need to have any 3D objects in it and never needs to be added to a channel.

### Order of passes
You can reorder sketches by clicking and holding on them in the sidebar. This relates to the order in which passes are added to the composer. If passes are added to sketches across multiple scenes, the order of the scenes is also important.

## Reloading sketches / Auto reload
If you have the "Watch sketches" setting enabled, Hedron will automatically refresh your sketches. However, if you don't have this enabled or something went wrong with the file watch (e.g. your sketch imports a file outside of its own folder) you'll need to click "Reload File" to see changes made to sketch files.

Expand Down
19 changes: 19 additions & 0 deletions docs/user-guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,25 @@ This refresh will remove the sketch from the scene, import any new params or sho

**Please note: File change detection may not work with all text editors. (e.g. Atom on OSX is reported to be inconsistent).**

## Post Processing
Sketches that make use of post processing features can be added to a scene like any normal sketch. The difference being that they may not add any objects to the scene and instead add effect passes to the rendering of that scene. If you are using more than one post processing sketch, the order of the sketches determines the order of the passes.

### Global post processing
By default, any post processing will only affect the scene that sketch is in. This means that fading the scene out on the crossfader will also fade out any post processing effects you have in that scene. However, by checking "Global Post Processing" under the scene settings, the post processing for that scene will now work across all scenes. An icon will appear on the scene thumbnail if this setting is enabled. The scene does not need to be added to any channel, `update` will always be running with this setting on.

As a convention, it makes sense to have a global post processing scene, with post processing related sketches added to it. This scene does not need to have any 3D objects in it and never needs to be added to a channel.

### Order of passes
You can reorder sketches by clicking and holding on them in the sidebar. This relates to the order in which passes are added to the composer. If you have more than one global post processing scene, the order of scenes is also taken into account. You can reorder scenes in the same way as sketches, by clicking and holding them before dragging.

### Global postprocessing
By default, any post processing will only affect the scene that sketch is in. This means that fading the scene out on the crossfader will also fade out any post processing effects you have in that scene. However, by checking "Global Post Processing" enabled under the scene settings, the effect will now work across all scenes. An icon will appear on the scene thumbnail if this setting is enabled. The scene does not need to be added to any channel, `update` will always be running with this setting on.

As a convention, it makes sense to have a post processing scene, with post processing related sketches added to it. This scene does not need to have any 3D objects in it and never needs to be added to a channel.

### Order of passes
You can reorder sketches by clicking and holding on them in the sidebar. This relates to the order in which passes are added to the composer. If passes are added to sketches across multiple scenes, the order of the scenes is also important.

## Macros
Macros make it possible to control many params at once. To start using macros, click on "Macros" on the right sidebar.

Expand Down
1 change: 1 addition & 0 deletions example-projects/basic.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"nodes":{"sceneCrossfader":{"id":"sceneCrossfader","value":0,"inputLinkIds":[],"shotCount":0,"connectedMacroIds":[],"title":"Scene Crossfader","type":"param","valueType":"float","optionIds":[]},"viewerMode":{"id":"viewerMode","value":"mix","inputLinkIds":[],"shotCount":0,"connectedMacroIds":[],"title":"Viewer Mode","valueType":"enum","options":[{"value":"mix","label":"Mix"},{"value":"A","label":"A"},{"value":"B","label":"B"}],"optionIds":[]},"sketchOrganization":{"id":"sketchOrganization","value":"category","inputLinkIds":[],"shotCount":0,"connectedMacroIds":[],"title":"Sketch Organization","valueType":"enum","options":[{"value":"folder","label":"Folder"},{"value":"category","label":"Category"},{"value":"author","label":"Author"}],"optionIds":[]},"audioLevelsFalloff":{"id":"audioLevelsFalloff","value":1,"inputLinkIds":[],"shotCount":0,"connectedMacroIds":[],"title":"Levels Falloff","type":"param","valueType":"float","optionIds":[]},"audioLevelsPower":{"id":"audioLevelsPower","value":0.25,"inputLinkIds":[],"shotCount":0,"connectedMacroIds":[],"title":"Levels Power","type":"param","min":0.5,"max":3,"valueType":"float","optionIds":[]},"audioLevelsSmoothing":{"id":"audioLevelsSmoothing","value":0,"inputLinkIds":[],"shotCount":0,"connectedMacroIds":[],"title":"Levels Smoothing","type":"param","valueType":"float","optionIds":[]},"audioNormalizeLevels":{"id":"audioNormalizeLevels","value":0.5,"inputLinkIds":[],"shotCount":0,"connectedMacroIds":[],"title":"Normalize Levels","type":"param","valueType":"float","optionIds":[]},"audioNormalizeRangeFalloff":{"id":"audioNormalizeRangeFalloff","value":0.01,"inputLinkIds":[],"shotCount":0,"connectedMacroIds":[],"title":"Normalized Range Falloff","type":"param","valueType":"float","optionIds":[]},"n31pv3n":{"id":"n31pv3n","value":0,"inputLinkIds":[],"shotCount":0,"connectedMacroIds":[],"type":"linkableAction","action":{"type":"U_SCENE_SELECT_CHANNEL","payload":{"id":"vmc8jmw","channel":"A"}},"title":"Add to A","optionIds":[]},"9ymdgux":{"id":"9ymdgux","value":0,"inputLinkIds":[],"shotCount":0,"connectedMacroIds":[],"type":"linkableAction","action":{"type":"U_SCENE_SELECT_CHANNEL","payload":{"id":"vmc8jmw","channel":"B"}},"title":"Add to B","optionIds":[]},"x2ch3dn":{"id":"x2ch3dn","value":0,"inputLinkIds":[],"shotCount":0,"connectedMacroIds":[],"type":"linkableAction","action":{"type":"U_SCENE_SELECT_CHANNEL","payload":{"id":"vmc8jmw","channel":"active"}},"title":"Add to Active","optionIds":[]},"3vmwtij":{"id":"3vmwtij","value":0,"inputLinkIds":[],"shotCount":0,"connectedMacroIds":[],"type":"linkableAction","action":{"type":"U_SCENE_SELECT_CHANNEL","payload":{"id":"vmc8jmw","channel":"opposite"}},"title":"Add to Opposite","optionIds":[]},"tr7sy0e":{"id":"tr7sy0e","value":0,"inputLinkIds":[],"shotCount":0,"connectedMacroIds":[],"type":"linkableAction","action":{"type":"SCENE_CLEAR_CHANNEL","payload":{"id":"vmc8jmw"}},"title":"Clear","optionIds":[]},"v30d915":{"id":"v30d915","value":0.5833333333333334,"inputLinkIds":[],"shotCount":0,"connectedMacroIds":[],"sketchId":"arrq26q","title":"Rotation Speed X","valueType":"float","type":"param","key":"rotSpeedX","hidden":false,"min":-1,"max":1,"defaultMin":-1,"defaultMax":1,"optionIds":[]},"rhibicn":{"id":"rhibicn","value":0.5,"inputLinkIds":[],"shotCount":0,"connectedMacroIds":[],"sketchId":"arrq26q","title":"Rotation Speed Y","valueType":"float","type":"param","key":"rotSpeedY","hidden":false,"min":-1,"max":1,"defaultMin":-1,"defaultMax":1,"optionIds":[]},"687svyd":{"id":"687svyd","value":0.5,"inputLinkIds":[],"shotCount":0,"connectedMacroIds":[],"sketchId":"arrq26q","title":"Rotation Speed Z","valueType":"float","type":"param","key":"rotSpeedZ","hidden":false,"min":-1,"max":1,"defaultMin":-1,"defaultMax":1,"optionIds":[]},"0k9feb2":{"id":"0k9feb2","value":0.7760301604699178,"inputLinkIds":["fhpikiv"],"shotCount":0,"connectedMacroIds":[],"sketchId":"arrq26q","title":"Scale","valueType":"float","type":"param","key":"scale","hidden":false,"min":0.00001,"max":4,"defaultMin":0.00001,"defaultMax":4,"openedLinkId":"fhpikiv","activeInputLinkId":"fhpikiv","optionIds":[]},"kg7ejk7":{"id":"kg7ejk7","value":true,"inputLinkIds":[],"shotCount":0,"connectedMacroIds":[],"sketchId":"arrq26q","title":"Wireframe","valueType":"boolean","type":"param","key":"isWireframe","hidden":false,"optionIds":[]},"ym3l08c":{"id":"ym3l08c","value":"icosa","inputLinkIds":[],"shotCount":0,"connectedMacroIds":[],"sketchId":"arrq26q","title":"geomName","valueType":"enum","type":"param","key":"geomName","hidden":false,"options":[{"value":"cube","label":"Cube"},{"value":"tetra","label":"Tetra"},{"value":"octa","label":"Octa"},{"value":"icosa","label":"Icosa"},{"value":"dodeca","label":"Dodeca"}],"optionIds":[]},"cpt12qc":{"id":"cpt12qc","value":0,"inputLinkIds":["ovn0f5p"],"shotCount":135,"connectedMacroIds":[],"sketchId":"arrq26q","type":"shot","valueType":"shotFloat","title":"Random Geom","method":"randomGeom","openedLinkId":"ovn0f5p","activeInputLinkId":"ovn0f5p","optionIds":[]},"w6iy3g4":{"id":"w6iy3g4","value":1,"inputLinkIds":[],"shotCount":0,"connectedMacroIds":[],"sketchId":"s8ymimc","title":"Opacity","valueType":"float","type":"param","key":"opacity","hidden":false,"min":0,"max":1,"defaultMin":0,"defaultMax":1,"optionIds":[]},"u86y54g":{"id":"u86y54g","value":0.26666666666666666,"inputLinkIds":[],"shotCount":0,"connectedMacroIds":[],"sketchId":"s8ymimc","title":"Speed","valueType":"float","type":"param","key":"speed","hidden":false,"min":-1,"max":1,"defaultMin":-1,"defaultMax":1,"optionIds":[]},"chx6d5o":{"id":"chx6d5o","value":[1,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0],"inputLinkIds":[],"shotCount":0,"connectedMacroIds":[],"optionIds":[]},"5m75das":{"id":"5m75das","value":0,"inputLinkIds":[],"shotCount":0,"connectedMacroIds":[],"type":"linkableAction","title":"Toggle Activate","action":{"type":"NODE_ACTIVE_INPUT_LINK_TOGGLE","payload":{"nodeId":"cpt12qc","linkId":"ovn0f5p"}},"sketchId":"arrq26q","parentNodeId":"ovn0f5p","optionIds":[]},"ovn0f5p":{"id":"ovn0f5p","value":0,"inputLinkIds":[],"shotCount":0,"connectedMacroIds":[],"title":"seq-step","type":"inputLink","input":{"id":"seq-step","type":"seq-step"},"nodeId":"cpt12qc","sketchId":"arrq26q","parentNodeId":"cpt12qc","nodeType":"shot","modifierIds":[],"optionIds":[],"linkableActions":{"toggleActivate":"5m75das"},"sequencerGridId":"chx6d5o","linkType":"node"},"kqprtqm":{"id":"kqprtqm","value":0,"inputLinkIds":[],"shotCount":0,"connectedMacroIds":[],"parentNodeId":"fhpikiv","sketchId":"arrq26q","key":"threshold","title":"Threshold","passToNext":false,"valueType":"float","subNode":true,"optionIds":[]},"yroim9l":{"id":"yroim9l","value":0.30952380952380953,"inputLinkIds":[],"shotCount":0,"connectedMacroIds":[],"parentNodeId":"fhpikiv","sketchId":"arrq26q","key":"range","title":"Lower Range","passToNext":true,"valueType":"float","subNode":true,"optionIds":[]},"xgtissg":{"id":"xgtissg","value":0.8095238095238095,"inputLinkIds":[],"shotCount":0,"connectedMacroIds":[],"parentNodeId":"fhpikiv","sketchId":"arrq26q","key":"range","title":"Upper Range","passToNext":false,"valueType":"float","subNode":true,"optionIds":[]},"a7ot2o4":{"id":"a7ot2o4","value":0,"inputLinkIds":[],"shotCount":0,"connectedMacroIds":[],"parentNodeId":"fhpikiv","sketchId":"arrq26q","key":"increment","title":"Increment","passToNext":false,"valueType":"enum","options":[{"value":0,"label":"Off"},{"value":1,"label":"Increment"},{"value":2,"label":"Decrement"}],"subNode":true,"optionIds":[]},"bpvs8wy":{"id":"bpvs8wy","value":"sine","inputLinkIds":[],"shotCount":0,"connectedMacroIds":[],"title":"Shape","key":"shape","valueType":"enum","subNode":true,"options":[{"value":"sine","label":"Sine"},{"value":"square","label":"Square"},{"value":"sawtooth","label":"Sawtooth"},{"value":"rSawtooth","label":"Revese Sawtooth"},{"value":"triangle","label":"Triangle"},{"value":"noise","label":"Noise"}],"sketchId":"arrq26q","parentNodeId":"fhpikiv","optionIds":[]},"rcgxus4":{"id":"rcgxus4","value":0.5,"inputLinkIds":[],"shotCount":0,"connectedMacroIds":[],"title":"Rate","key":"rate","valueType":"enum","subNode":true,"options":[{"value":32,"label":"32"},{"value":16,"label":"16"},{"value":8,"label":"8"},{"value":4,"label":"4"},{"value":2,"label":"2"},{"value":1,"label":"1"},{"value":0.5,"label":"1/2"},{"value":0.25,"label":"1/4"},{"value":0.125,"label":"1/8"},{"value":0.0625,"label":"1/16"},{"value":0.03125,"label":"1/32"}],"sketchId":"arrq26q","parentNodeId":"fhpikiv","optionIds":[]},"y9cm37u":{"id":"y9cm37u","value":0,"inputLinkIds":[],"shotCount":0,"connectedMacroIds":[],"title":"Phase","key":"phase","valueType":"float","subNode":true,"sketchId":"arrq26q","parentNodeId":"fhpikiv","optionIds":[]},"sfcajf7":{"id":"sfcajf7","value":-1,"inputLinkIds":[],"shotCount":0,"connectedMacroIds":[],"title":"Seed","key":"seed","valueType":"enum","subNode":true,"options":[{"value":-1,"label":"auto"},{"value":0,"label":"0"},{"value":1,"label":"1"},{"value":2,"label":"2"},{"value":3,"label":"3"},{"value":4,"label":"4"},{"value":5,"label":"5"},{"value":6,"label":"6"},{"value":7,"label":"7"},{"value":8,"label":"8"},{"value":9,"label":"9"},{"value":10,"label":"10"},{"value":11,"label":"11"},{"value":12,"label":"12"},{"value":13,"label":"13"},{"value":14,"label":"14"},{"value":15,"label":"15"},{"value":16,"label":"16"},{"value":17,"label":"17"},{"value":18,"label":"18"},{"value":19,"label":"19"},{"value":20,"label":"20"},{"value":21,"label":"21"},{"value":22,"label":"22"},{"value":23,"label":"23"},{"value":24,"label":"24"}],"sketchId":"arrq26q","parentNodeId":"fhpikiv","optionIds":[]},"0frcu4g":{"id":"0frcu4g","value":0,"inputLinkIds":[],"shotCount":0,"connectedMacroIds":[],"type":"linkableAction","title":"Toggle Activate","action":{"type":"NODE_ACTIVE_INPUT_LINK_TOGGLE","payload":{"nodeId":"0k9feb2","linkId":"fhpikiv"}},"sketchId":"arrq26q","parentNodeId":"fhpikiv","optionIds":[]},"fhpikiv":{"id":"fhpikiv","value":0,"inputLinkIds":[],"shotCount":0,"connectedMacroIds":[],"title":"lfo","type":"inputLink","input":{"id":"lfo","type":"lfo"},"nodeId":"0k9feb2","sketchId":"arrq26q","parentNodeId":"0k9feb2","nodeType":"param","modifierIds":["kqprtqm","yroim9l","xgtissg","a7ot2o4"],"optionIds":["bpvs8wy","rcgxus4","y9cm37u","sfcajf7"],"linkableActions":{"toggleActivate":"0frcu4g"},"linkType":"node"},"areErrorPopupsDisabled":{"title":"Disable Error Popups","id":"areErrorPopupsDisabled","valueType":"boolean","value":false}},"scenes":{"items":{"vmc8jmw":{"id":"vmc8jmw","title":"Basic","selectedSketchId":"arrq26q","sketchIds":["arrq26q","s8ymimc"],"linkableActionIds":{"addToA":"n31pv3n","addToB":"9ymdgux","addToActive":"x2ch3dn","addToOpposite":"3vmwtij","clear":"tr7sy0e"},"settings":{}}},"sceneIds":["vmc8jmw"],"currentSceneId":"vmc8jmw","channels":{"A":"vmc8jmw","B":false}},"sketches":{"arrq26q":{"title":"Solid","moduleId":"solid","paramIds":["v30d915","rhibicn","687svyd","0k9feb2","kg7ejk7","ym3l08c"],"shotIds":["cpt12qc"],"openedNodeId":"0k9feb2"},"s8ymimc":{"title":"Stars","moduleId":"stars","paramIds":["w6iy3g4","u86y54g"],"shotIds":[]}},"project":{"filePath":"/Users/alex/Sites/GitHub/hedron/example-projects/basic.json","sketchesPath":"/Users/alex/Sites/GitHub/hedron/example-projects/sketches","errors":[],"errorPopup":false},"inputs":{"audio":{"value":[0.030403629225992095,0,0,0],"assignedLinkIds":[]},"lfo":{"value":194.33333333333334,"assignedLinkIds":["fhpikiv"]},"seq-step":{"assignedLinkIds":["ovn0f5p"],"value":18}},"inputLinks":{"nodeIds":[null]},"midi":{"learning":false,"devices":{"IAC Driver IAC Bus 1":{"title":"IAC Driver IAC Bus 1","id":"IAC Driver IAC Bus 1","manufacturer":"Apple Inc.","settings":{"forceChannel":{"value":false,"label":"-"}}}},"connectedDeviceIds":["IAC Driver IAC Bus 1"]},"macros":{"learningId":false,"nodeIds":[]},"ui":{"panelWidths":{"left":50},"isEditing":false,"openedNode":false,"auxOpen":["sketchcat_simple"],"addSketchOpen":{}},"router":{"location":{"pathname":"/scenes/view","search":"","hash":"","key":"d61u3f"},"action":"PUSH"},"settings":{"clockGenerated":true,"clockBpm":120,"aspectW":16,"aspectH":9,"throttledFPS":60,"watchSketchesDir":true},"form":{"device_IAC Driver IAC Bus 1":{"values":{"forceChannel":{"value":false,"label":"-"}},"initial":{"forceChannel":{"value":false,"label":"-"}},"registeredFields":{"forceChannel":{"name":"forceChannel","type":"Field","count":1}}},"sceneManager":{"values":{},"initial":{},"registeredFields":{"globalPostProcessingEnabled":{"name":"globalPostProcessingEnabled","type":"Field","count":1}}}}}
1 change: 1 addition & 0 deletions example-projects/fragment-shader.json

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions example-projects/logo.json

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions example-projects/postprocessing.json

Large diffs are not rendered by default.

Loading

0 comments on commit c720e5a

Please sign in to comment.