Merge branch 'feature/value_modification' into develop

Author: Hannes Kruse

src/lib/menu/checkbox.ts

@@ -4,7 +4,12 @@ import ColorFactory from "../../utlis/color-factory";
 import {Path, Rectangle, Size} from "paper";
 import {ZERO_POINT as CENTER} from "../constants";
 
+/**
+ * A Checkbox is either selected or not
+ */
 export default class Checkbox extends MenuItem {
+    public readonly TYPE = 'checkbox';
+
     /**
      * Selection Flag
      */
@@ -21,14 +26,27 @@ export default class Checkbox extends MenuItem {
         }
     }
 
+    /**
+     * Set the checkbox state to deselected
+     */
     public deselect(): void {
         this.itemSelected = false;
     }
 
+    /**
+     * Set the checkbox state to selected
+     */
     public select(): void {
         this.itemSelected = true;
     }
 
+    /**
+     * True if checkbox is selected
+     */
+    public isSelected(): boolean {
+        return this.itemSelected === true;
+    }
+
     /**
      * @see setGeometryColorSelected
      */

src/lib/menu/menu-parser.ts

@@ -10,7 +10,7 @@ export default class MenuParser {
     /**
      * List of already used menu item ids
      */
-    private itemIds: Map<string, MenuItem> = new Map<string, MenuItem>();
+    private _itemIds: Map<string, MenuItem> = new Map<string, MenuItem>();
 
     /**
      * Parses a JSON Structure to Menu Items
@@ -39,6 +39,7 @@ export default class MenuParser {
                         item = new Crankslider(structure.id, structure.direction, structure.text, structure.icon);
                         break;
 
+                    case 'slider':
                     case 'ribbonslider':
                         item = new Ribbonslider(structure.id, structure.direction, structure.text, structure.icon);
                         break;
@@ -47,6 +48,7 @@ export default class MenuParser {
                         item = new Checkbox(structure.id, structure.direction, structure.text, structure.icon);
                         break;
 
+                    case 'radiogroup':
                     case 'radio-group':
                         item = new RadioGroup(structure.id, structure.direction, structure.text, structure.icon);
                         break;
@@ -60,7 +62,7 @@ export default class MenuParser {
             MenuParser.checkAngles(item);
         }
 
-        this.itemIds.set(structure.id, item);
+        this._itemIds.set(structure.id, item);
 
         structure.children && structure.children.forEach((child): void => {
             this.parse(child, item);
@@ -73,15 +75,22 @@ export default class MenuParser {
         return item;
     }
 
+    /**
+     * Parsed menu structure accessible through the item id
+     */
+    public get map(): Map<string, MenuItem> {
+        return this._itemIds;
+    }
+
     /**
      * Checks if an item id is already in use by another item.
      * Writes a warning to the console
      *
      * @param {string} itemId
      */
     private checkIds(itemId: string): void {
-        if (this.itemIds.has(itemId)) {
-            const item = this.itemIds.get(itemId) as MenuItem;
+        if (this._itemIds.has(itemId)) {
+            const item = this._itemIds.get(itemId) as MenuItem;
             console.warn(`Menu Item ID '${itemId}' already in use by Menu Item '${item.itemId}' with Parent '${(item.parent as MenuItem).itemId}'.`);
         }
     }

src/lib/menu/radio-group.ts

@@ -2,15 +2,41 @@ import MenuItem from "./menu-item";
 import Checkbox from "./checkbox";
 import {ItemState, MenuItemEventType} from "../enums";
 
+/**
+ * A Radio group contains >=2 Checkboxes of which only one can be active at a given time
+ */
 export default class RadioGroup extends MenuItem {
+    public readonly TYPE = 'radiogroup';
+
+    /**
+     * Selects a single child from the radio group
+     *
+     * @param {string} itemId
+     */
+    public select(itemId: string) {
+        const toSelect = <Checkbox | undefined>this.getChildren().find(item => {
+            return item.itemId === itemId;
+        });
+
+        if (typeof toSelect === "undefined") {
+            return;
+        }
+
+        this.deselectChildren();
+        toSelect.select();
+    }
+
+    /**
+     * Deselect all children to ensure only one is active
+     *
+     * @inheritDoc
+     */
     protected changeActive(): void {
         if (this.state !== ItemState.ACTIVE) {
             return;
         }
 
-        (<Checkbox[]>this.getChildren()).forEach(child => {
-            child.deselect();
-        });
+        this.deselectChildren();
 
         this.activeChild = this.getNearestChild(this.angleToReferencePoint(this.menu.inputPosition));
 
@@ -23,10 +49,19 @@ export default class RadioGroup extends MenuItem {
                 this.event(MenuItemEventType.HOVER_SELECTION, this.activeChild);
             } else {
                 this.activeChild.state = ItemState.SELECTED;
-                (this.activeChild as Checkbox).select();
+                (<Checkbox>this.activeChild).select();
             }
         }
 
         this.root.redraw();
     }
+
+    /**
+     * Set checkbox state to deselect
+     */
+    private deselectChildren(): void {
+        (<Checkbox[]>this.getChildren()).forEach(child => {
+            child.deselect();
+        });
+    }
 }

src/lib/menu/ribbonslider.ts

@@ -21,6 +21,8 @@ import Arc from "../../utlis/arc";
 import {precision, roundNumber} from "../../utlis/numbers";
 
 export default class Ribbonslider extends MenuItem {
+    public readonly TYPE = 'ribbonslider';
+
     /**
      * Group holding
      * - Ribbon
@@ -156,7 +158,7 @@ export default class Ribbonslider extends MenuItem {
      * @param value number Slider value
      * @see {throttledTextUpdate}
      */
-    private set value(value: number) {
+    public set value(value: number) {
         if (this._value === value) {
             return;
         }
@@ -166,6 +168,15 @@ export default class Ribbonslider extends MenuItem {
         this.throttledTextUpdate('' + value);
     }
 
+    /**
+     * Accessor
+     *
+     * @see {_value}
+     */
+    public get value(): number {
+        return this._value;
+    }
+
     /**
      * Accessor
      *
@@ -231,15 +242,6 @@ export default class Ribbonslider extends MenuItem {
         return this._ribbonMaskGroup;
     }
 
-    /**
-     * Accessor
-     *
-     * @see {_value}
-     */
-    private get value(): number {
-        return this._value;
-    }
-
     /**
      * Moves the Ribbon to a given position of a slider value
      * @param value