(rsg) Implemented ProgressDialog node (#899)

* (rsg) Implemented ProgressDialog node

* Fixed formatting

Author: lvcabral

docs/limitations.md

@@ -14,7 +14,7 @@ The **BrightScript Engine** implements the BrightScript language specification u
     * The basic nodes: `ContentNode`, `Group`, `Scene`, `Global`, `Timer`, `Rectangle`, `Poster`, `LayoutGroup` and `RSGPalette`
     * Typographic nodes: `Font`, `Label`, `ScrollingLabel` and `ScrollableText`
     * Grids and list nodes based on `ArrayGrid`: `PosterGrid`, `LabelList`, `CheckList`, `RadioButtonList`, `MarkupList`, `MarkupGrid`, `RowList` and `ZoomRowList`
-    * Dialog related nodes: `Dialog`, `KeyboardDialog`, `PinDialog`, `StandardDialog`, `StandardProgressDialog`, `StdDlgProgressItem`, `StdDlgContentArea` and `StdDlgTitleArea`
+    * Dialog related nodes: `Dialog`, `KeyboardDialog`, `PinDialog`, `ProgressDialog`, `StandardDialog`, `StandardProgressDialog`, `StdDlgProgressItem`, `StdDlgContentArea` and `StdDlgTitleArea`
     * Media related nodes: `Audio`, `SoundEffect`, `Video` and `TrickPlayBar`
     * Animation related nodes: `AnimationBase`, `Animation`, `SequentialAnimation`, `ParallelAnimation`, `ColorFieldInterpolator`, `FloatFieldInterpolator` and `Vector2DFieldInterpolator`
     * Panel related nodes: `OverhangPanelSetScene`, `PanelSet`, `Panel`, `GridPanel` and `ListPanel`

src/extensions/scenegraph/factory/NodeFactory.ts

@@ -65,6 +65,7 @@ import {
     StandardDialog,
     StandardKeyboardDialog,
     StandardProgressDialog,
+    ProgressDialog,
     StdDlgContentArea,
     StdDlgProgressItem,
     StdDlgTitleArea,
@@ -227,6 +228,8 @@ export class SGNodeFactory {
                 return new StandardKeyboardDialog([], name);
             case SGNodeType.StandardProgressDialog.toLowerCase():
                 return new StandardProgressDialog([], name);
+            case SGNodeType.ProgressDialog.toLowerCase():
+                return new ProgressDialog([], name);
             case SGNodeType.StdDlgContentArea.toLowerCase():
                 return new StdDlgContentArea([], name);
             case SGNodeType.StdDlgTitleArea.toLowerCase():

src/extensions/scenegraph/nodes/ProgressDialog.ts

@@ -0,0 +1,77 @@
+import { AAMember, BrsBoolean, BrsString, Float } from "brs-engine";
+import { FieldModel } from "../SGTypes";
+import { SGNodeType } from ".";
+import { Dialog } from "./Dialog";
+import { BusySpinner } from "./BusySpinner";
+
+export class ProgressDialog extends Dialog {
+    readonly defaultFields: FieldModel[] = [{ name: "busySpinner", type: "node" }];
+
+    protected readonly minHeight: number;
+    private readonly spinner: BusySpinner;
+
+    constructor(initializedFields: AAMember[] = [], readonly name: string = SGNodeType.ProgressDialog) {
+        super([], name);
+        this.setExtendsType(name, SGNodeType.Dialog);
+
+        this.registerDefaultFields(this.defaultFields);
+        this.registerInitializedFields(initializedFields);
+
+        this.spinner = new BusySpinner();
+
+        // Resize the dialog and position the spinner, resolution-aware
+        let spinnerSize: number;
+        let spinnerY: number;
+
+        if (this.resolution === "FHD") {
+            spinnerSize = 120;
+            spinnerY = this.dialogTrans[1] + 105 + this.vertOffset + this.gap;
+            this.minHeight = 159 + spinnerSize + this.vertOffset * 2;
+        } else {
+            spinnerSize = 80;
+            spinnerY = this.dialogTrans[1] + 70 + this.vertOffset + this.gap;
+            this.minHeight = 106 + spinnerSize + this.vertOffset * 2;
+        }
+        this.height = this.minHeight;
+
+        // Center spinner horizontally within the dialog
+        const spinnerX = this.dialogTrans[0] + (this.width - spinnerSize) / 2;
+        this.spinner.setTranslation([spinnerX, spinnerY]);
+        this.spinner.setValue("control", new BrsString("start"));
+        this.setValueSilent("busySpinner", this.spinner);
+
+        // Adjust background height
+        this.background.setValueSilent("height", new Float(this.minHeight));
+
+        // Hide elements not used by ProgressDialog
+        this.message.setValueSilent("visible", BrsBoolean.False);
+        this.icon.setValueSilent("visible", BrsBoolean.False);
+        this.setValueSilent("iconUri", new BrsString(""));
+
+        this.appendChildToParent(this.spinner);
+    }
+
+    protected updateChildren() {
+        this.height = this.minHeight;
+        const width = this.getValueJS("width") as number;
+        if (width) {
+            this.background.setValue("width", new Float(width));
+            this.width = width;
+        }
+        this.copyField(this.background, "uri", "backgroundUri");
+        this.copyField(this.title, "text", "title");
+        this.copyField(this.title, "color", "titleColor");
+        this.copyField(this.title, "font", "titleFont");
+        this.copyField(this.divider, "uri", "dividerUri");
+
+        // Set dialog height and reposition elements
+        const newY = (this.sceneRect.height - this.height) / 2;
+        const offsetY = newY - this.dialogTrans[1];
+        this.dialogTrans[1] = newY;
+        this.background.setTranslation(this.dialogTrans);
+        this.background.setValue("height", new Float(this.height));
+        this.title.setTranslationOffset(0, offsetY);
+        this.divider.setTranslationOffset(0, offsetY);
+        this.spinner.setTranslationOffset(0, offsetY);
+    }
+}

src/extensions/scenegraph/nodes/index.ts

@@ -43,6 +43,7 @@ export * from "./SoundEffect";
 export * from "./StandardDialog";
 export * from "./StandardKeyboardDialog";
 export * from "./StandardProgressDialog";
+export * from "./ProgressDialog";
 export * from "./StdDlgContentArea";
 export * from "./StdDlgProgressItem";
 export * from "./StdDlgTitleArea";
@@ -89,7 +90,7 @@ export enum SGNodeType {
     StandardMessageDialog = "StandardMessageDialog", // Not yet implemented
     StandardPinPadDialog = "StandardPinPadDialog", // Not yet implemented
     StandardProgressDialog = "StandardProgressDialog",
-    ProgressDialog = "ProgressDialog", // Not yet implemented
+    ProgressDialog = "ProgressDialog",
     StdDlgActionCardItem = "StdDlgActionCardItem", // Not yet implemented
     StdDlgAreaBase = "StdDlgAreaBase", // Not yet implemented
     StdDlgBulletTextItem = "StdDlgBulletTextItem", // Not yet implemented