Refactoring/fields (#40)

* Rename output to blendMode in ColorMap

* Rename BlendMode keys & Add Minimum & Absolute Difference

* AVERAGE -> FIFTY_FIFTY
* SUBTRACTIVE1/2 -> SUB_DEST_SRC/SUB_SRC_DEST
* add MINIMUM
* add ABSOLUTE_DIFFERENCE

* Rename Channels/Source to AudioChannels/AudioSource

* Channels -> AudioChannels
* Source -> AudioSource
* source/channel -> audioSource/audioChannel in SuperScope
* source -> audioSource in Texer

* Rename coordinate mode RECT to CARTESIAN

* Rename various enums in ColorMap & BufferSave

ColorMap:
* ONBEATSEQUENTIAL -> ONBEAT_SEQUENTIAL
* ONBEATRANDOM -> ONBEAT_RANDOM
* (R+G+B)/2 -> CHANNEL_SUM_HALF
* (R+G+B)/3 -> CHANNEL_AVERAGE

BufferSave:
* SAVERESTORE -> ALTERNATE_SAVE_RESTORE
* RESTORESAVE -> ALTERNATE_RESTORE_SAVE

Fix shader code indentation in ColorMap.

* Add newlines at ends of various files

* Rename channel to mode in ChannelShift

Author: grandchild

examples/JelloCube.js

@@ -39,7 +39,7 @@ addExamplePreset({
         },
         {
             "type": "ColorMap",
-            "output": "REPLACE",
+            "blendMode": "REPLACE",
             "key": "RED",
             "maps": [
                 {
@@ -56,7 +56,7 @@ addExamplePreset({
             type: "EffectList",
             clearFrame: true,
             input: "IGNORE",
-            output: "SUBTRACTIVE1",
+            output: "SUB_DEST_SRC",
             components: [
                 {
                     type: "SuperScope",

examples/PillowFight.js

@@ -30,7 +30,7 @@ addExamplePreset({
                 {
                     "type": "DynamicMovement",
                     "noGrid": true,
-                    "coord": "RECT",
+                    "coord": "CARTESIAN",
                     "code": {
                         "perPixel": "x=-x"
                     }
@@ -76,7 +76,7 @@ addExamplePreset({
                 {
                     "type": "DynamicMovement",
                     "noGrid": true,
-                    "coord": "RECT",
+                    "coord": "CARTESIAN",
                     "code": {
                         "perPixel": "y=-y"
                     }
@@ -86,7 +86,7 @@ addExamplePreset({
         {
             "type": "ColorMap",
             "key": "RED",
-            "output": "REPLACE",
+            "blendMode": "REPLACE",
             "mapCycleMode": "SINGLE",
             "maps": [
                 {
@@ -118,7 +118,7 @@ addExamplePreset({
             "enabled": true,
             "clearFrame": false,
             "input": "IGNORE",
-            "output": "AVERAGE",
+            "output": "FIFTY_FIFTY",
             "components": [
                 {
                     "type": "BufferSave",
@@ -128,7 +128,7 @@ addExamplePreset({
                 },
                 {
                     "type": "DynamicMovement",
-                    "coord": "RECT",
+                    "coord": "CARTESIAN",
                     "noGrid": true,
                     "bFilter": false,
                     "code": {
@@ -160,8 +160,8 @@ addExamplePreset({
         {
             "type": "ColorMap",
             "key": "RED",
-            "output": "REPLACE",
-            "mapCycleMode": "ONBEATSEQUENTIAL",
+            "blendMode": "REPLACE",
+            "mapCycleMode": "ONBEAT_SEQUENTIAL",
             "maps": [
                 {
                     "enabled": true,
@@ -231,8 +231,8 @@ addExamplePreset({
         {
             "type": "ColorMap",
             "key": "MAX",
-            "output": "MULTIPLY",
-            "mapCycleMode": "ONBEATSEQUENTIAL",
+            "blendMode": "MULTIPLY",
+            "mapCycleMode": "ONBEAT_SEQUENTIAL",
             "maps": [
                 {
                     "enabled": true,
@@ -259,11 +259,11 @@ addExamplePreset({
         },
         {
             "type": "DynamicMovement",
-            "coord": "RECT",
+            "coord": "CARTESIAN",
             "noGrid": true,
             "code": {
                 "perPixel": "x=x-(1/6)"
             }
         }
     ]
-});
+});

examples/RandomAnja.js

@@ -52,7 +52,7 @@ addExamplePreset({
             },
             "noGrid": true,
             "bFilter": true,
-            "coord": "RECT",
+            "coord": "CARTESIAN",
             "gridW": 0,
             "gridH": 0,
             "blend": false,
@@ -80,7 +80,7 @@ addExamplePreset({
                 "perPoint": "x=x+xm;y=y+ym;"
             },
             "bFilter": true,
-            "coord": "RECT",
+            "coord": "CARTESIAN",
             "gridW": 0,
             "gridH": 0,
             "blend": false,
@@ -108,7 +108,7 @@ addExamplePreset({
                 "perPoint": "x=x+xm;y=y+ym;"
             },
             "bFilter": true,
-            "coord": "RECT",
+            "coord": "CARTESIAN",
             "gridW": 0,
             "gridH": 0,
             "blend": false,

examples/SilkString.js

@@ -140,7 +140,7 @@ addExamplePreset({
         },
         {
             "type": "ColorMap",
-            "output": "ADDITIVE",
+            "blendMode": "ADDITIVE",
             "maps": [
                 {
                     "enabled": true,
@@ -151,4 +151,4 @@ addExamplePreset({
             ]
         }
     ]
-});
+});

examples/SuperscopeScience.js

@@ -100,4 +100,4 @@ addExamplePreset({
       "enabled": true
     }
   ]
-});
+});

src/EffectList.ts

@@ -12,10 +12,11 @@ import TextureSetManager from "./webgl/TextureSetManager";
 export enum ELBlendMode {
     REPLACE = 1,
     MAXIMUM,
-    AVERAGE,
+    MINIMUM,
+    FIFTY_FIFTY,
     ADDITIVE,
-    SUBTRACTIVE1,
-    SUBTRACTIVE2,
+    SUB_DEST_SRC,
+    SUB_SRC_DEST,
     MULTIPLY,
     MULTIPLY2,
     ADJUSTABLE,

src/analyser/AnalyserAdapter.ts

@@ -1,4 +1,4 @@
-import { Channels, FloatArray } from "../utils";
+import { AudioChannels, FloatArray } from "../utils";
 
 /**
  * AnalyserAdapter adapts music data analysers so that it can be plugged into Webvs.
@@ -21,11 +21,11 @@ export default abstract class AnalyserAdapter {
      * Returns array of waveform values. Override and implement analyser code
      * @param channel channel for which waveform data will be returned
      */
-    public abstract getWaveform(channel?: Channels): FloatArray;
+    public abstract getWaveform(channel?: AudioChannels): FloatArray;
 
     /**
      * Returns array of spectrum values. Override and implement analyser code
      * @param channel channel for which spectrum data will be returned
      */
-    public abstract getSpectrum(channel?: Channels): FloatArray;
+    public abstract getSpectrum(channel?: AudioChannels): FloatArray;
 }

src/analyser/WebAudioAnalyser.ts

@@ -1,4 +1,4 @@
-import { Channels } from "../utils";
+import { AudioChannels } from "../utils";
 import AnalyserAdapter from "./AnalyserAdapter";
 
 interface IVisData {
@@ -193,12 +193,12 @@ export default class WebAudioAnalyser extends AnalyserAdapter {
     }
 
     // Returns array of waveform values
-    public getWaveform(channel: Channels = Channels.CENTER) {
+    public getWaveform(channel: AudioChannels = AudioChannels.CENTER) {
         return this.visData[channel].waveform;
     }
 
     // Returns array of spectrum values
-    public getSpectrum(channel: Channels = Channels.CENTER) {
+    public getSpectrum(channel: AudioChannels = AudioChannels.CENTER) {
         return this.visData[channel].spectrum;
     }
 

src/misc/BufferSave.ts

@@ -26,8 +26,8 @@ export interface IBufferSaveOpts {
 enum BufferSaveAction {
     SAVE = 0,
     RESTORE,
-    SAVERESTORE,
-    RESTORESAVE,
+    ALTERNATE_SAVE_RESTORE,
+    ALTERNATE_RESTORE_SAVE,
 }
 
 /**
@@ -65,8 +65,8 @@ export default class BufferSave extends Component {
 
     public draw() {
         let currentAction;
-        if (this.action === BufferSaveAction.SAVERESTORE ||
-           this.action === BufferSaveAction.RESTORESAVE) {
+        if (this.action === BufferSaveAction.ALTERNATE_SAVE_RESTORE ||
+           this.action === BufferSaveAction.ALTERNATE_RESTORE_SAVE) {
             currentAction = this.nextAction;
             // toggle next action
             this.nextAction =
@@ -96,9 +96,9 @@ export default class BufferSave extends Component {
 
     public updateAction() {
         this.action = BufferSaveAction[this.opts.action];
-        if (this.action === BufferSaveAction.SAVERESTORE) {
+        if (this.action === BufferSaveAction.ALTERNATE_SAVE_RESTORE) {
             this.nextAction = BufferSaveAction.SAVE;
-        } else if (this.action === BufferSaveAction.RESTORESAVE) {
+        } else if (this.action === BufferSaveAction.ALTERNATE_RESTORE_SAVE) {
             this.nextAction = BufferSaveAction.RESTORE;
         }
     }

src/render/SuperScope.ts

@@ -3,7 +3,7 @@ import Component, {IContainer} from "../Component";
 import CodeInstance from "../expr/CodeInstance";
 import compileExpr, { ICompileResult } from "../expr/compileExpr";
 import IMain from "../IMain";
-import { BlendMode, Channels, Color, parseColorNorm, Source, WebGLVarType } from "../utils";
+import { AudioChannels, AudioSource, BlendMode, Color, parseColorNorm, WebGLVarType } from "../utils";
 import Buffer from "../webgl/Buffer";
 import RenderingContext from "../webgl/RenderingContext";
 import ShaderProgram from "../webgl/ShaderProgram";
@@ -59,11 +59,11 @@ export interface ISuperScopeOpts {
     /**
      * Channel for scope values. Default: `CENTER`
      */
-    channel: string;
+    audioChannel: string;
     /**
      * Data source of scope value. Default: `SPECTRUM`
      */
-    source: string;
+    audioSource: string;
     /**
      * Drawing mode for the scope. see [[SuperScopeDrawMode]]. Default: `LINES`
      */
@@ -120,19 +120,20 @@ export default class SuperScope extends Component {
     public static componentName: string = "SuperScope";
     public static componentTag: string = "render";
     protected static optUpdateHandlers = {
+        audioChannel: "updateAudioChannel",
+        audioSource: "updateAudioSource",
         blendMode: "updateProgram",
-        channel: "updateChannel",
         clone: "updateClones",
         code: [ "updateCode", "updateClones"],
         colors: "updateColors",
         cycleSpeed: "updateSpeed",
         drawMode: "updateDrawMode",
-        source: "updateSource",
         thickness: "updateThickness",
     };
     protected static defaultOptions: ISuperScopeOpts = {
+        audioChannel: "CENTER",
+        audioSource: "SPECTRUM",
         blendMode: "REPLACE",
-        channel: "CENTER",
         clone: 1,
         code: {
             init: "n=800",
@@ -143,7 +144,6 @@ export default class SuperScope extends Component {
         colors: ["#ffffff"],
         cycleSpeed: 0.01,
         drawMode: "LINES",
-        source: "SPECTRUM",
         thickness: 1,
     };
 
@@ -153,8 +153,8 @@ export default class SuperScope extends Component {
     private code: ISSCodeInstance[];
     private inited: boolean;
     private program: ShaderProgram<ISuperScopeShaderValues>;
-    private source: Source;
-    private channel: Channels;
+    private audioSource: AudioSource;
+    private audioChannel: AudioChannels;
     private drawMode: SuperScopeDrawMode;
     private veryThick: boolean;
     private colors: Color[];
@@ -168,13 +168,13 @@ export default class SuperScope extends Component {
 
     public init() {
         this.updateDrawMode();
-        this.updateSource();
+        this.updateAudioSource();
         this.updateProgram();
         this.updateCode();
         this.updateClones();
         this.updateSpeed();
         this.updateColors();
-        this.updateChannel();
+        this.updateAudioChannel();
         this.updateThickness();
         this.listenTo(this.main, "resize", () => this.handleResize());
 
@@ -221,10 +221,10 @@ export default class SuperScope extends Component {
 
         const nPoints = Math.floor(code.n);
         let data;
-        if (this.source === Source.SPECTRUM) {
-            data = this.main.getAnalyser().getSpectrum(this.channel);
+        if (this.audioSource === AudioSource.SPECTRUM) {
+            data = this.main.getAnalyser().getSpectrum(this.audioChannel);
         } else {
-            data = this.main.getAnalyser().getWaveform(this.channel);
+            data = this.main.getAnalyser().getWaveform(this.audioChannel);
         }
         const dots = this.drawMode === SuperScopeDrawMode.DOTS;
         const bucketSize = data.length / nPoints;
@@ -466,12 +466,12 @@ export default class SuperScope extends Component {
         }
     }
 
-    private updateChannel() {
-        this.channel = Channels[this.opts.channel];
+    private updateAudioChannel() {
+        this.audioChannel = AudioChannels[this.opts.audioChannel];
     }
 
-    private updateSource() {
-        this.source = Source[this.opts.source];
+    private updateAudioSource() {
+        this.audioSource = AudioSource[this.opts.audioSource];
     }
 
     private updateDrawMode() {