@onerjs/gui 8.23.1

package/2D/controls/statics.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Forcing an export so that this code will execute
+ * @internal
+ */
+declare const Name = "Statics";
+export { Name as name };

package/2D/controls/statics.js

@@ -0,0 +1,50 @@
+import { Control } from "./control.js";
+import { StackPanel } from "./stackPanel.js";
+import { TextBlock } from "./textBlock.js";
+/**
+ * Forcing an export so that this code will execute
+ * @internal
+ */
+const Name = "Statics";
+export { Name as name };
+/**
+ * Creates a stack panel that can be used to render headers
+ * @param control defines the control to associate with the header
+ * @param text defines the text of the header
+ * @param size defines the size of the header
+ * @param options defines options used to configure the header
+ * @param options.isHorizontal
+ * @param options.controlFirst
+ * @returns a new StackPanel
+ */
+Control.AddHeader = function (control, text, size, options) {
+    const panel = new StackPanel("panel");
+    const isHorizontal = options ? options.isHorizontal : true;
+    const controlFirst = options ? options.controlFirst : true;
+    panel.isVertical = !isHorizontal;
+    const header = new TextBlock("header");
+    header.text = text;
+    header.textHorizontalAlignment = Control.HORIZONTAL_ALIGNMENT_LEFT;
+    if (isHorizontal) {
+        header.width = size;
+    }
+    else {
+        header.height = size;
+    }
+    if (controlFirst) {
+        panel.addControl(control);
+        panel.addControl(header);
+        header.paddingLeft = "5px";
+    }
+    else {
+        panel.addControl(header);
+        panel.addControl(control);
+        header.paddingRight = "5px";
+    }
+    header.shadowBlur = control.shadowBlur;
+    header.shadowColor = control.shadowColor;
+    header.shadowOffsetX = control.shadowOffsetX;
+    header.shadowOffsetY = control.shadowOffsetY;
+    return panel;
+};
+//# sourceMappingURL=statics.js.map

package/2D/controls/statics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"statics.js","sourceRoot":"","sources":["../../../../../dev/gui/src/2D/controls/statics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;;GAGG;AACH,MAAM,IAAI,GAAG,SAAS,CAAC;AAEvB,OAAO,EAAE,IAAI,IAAI,IAAI,EAAE,CAAC;AAExB;;;;;;;;;GASG;AACH,OAAO,CAAC,SAAS,GAAG,UAAU,OAAgB,EAAE,IAAY,EAAE,IAAqB,EAAE,OAAyD;IAC1I,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,OAAO,CAAC,CAAC;IACtC,MAAM,YAAY,GAAG,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC;IAC3D,MAAM,YAAY,GAAG,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC;IAE3D,KAAK,CAAC,UAAU,GAAG,CAAC,YAAY,CAAC;IAEjC,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC,QAAQ,CAAC,CAAC;IACvC,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,MAAM,CAAC,uBAAuB,GAAG,OAAO,CAAC,yBAAyB,CAAC;IACnE,IAAI,YAAY,EAAE,CAAC;QACf,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC;IACxB,CAAC;SAAM,CAAC;QACJ,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC;IACzB,CAAC;IAED,IAAI,YAAY,EAAE,CAAC;QACf,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC1B,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACzB,MAAM,CAAC,WAAW,GAAG,KAAK,CAAC;IAC/B,CAAC;SAAM,CAAC;QACJ,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACzB,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC1B,MAAM,CAAC,YAAY,GAAG,KAAK,CAAC;IAChC,CAAC;IAED,MAAM,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IACvC,MAAM,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;IACzC,MAAM,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;IAC7C,MAAM,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;IAE7C,OAAO,KAAK,CAAC;AACjB,CAAC,CAAC","sourcesContent":["import { Control } from \"./control\";\r\nimport { StackPanel } from \"./stackPanel\";\r\nimport { TextBlock } from \"./textBlock\";\r\n\r\n/**\r\n * Forcing an export so that this code will execute\r\n * @internal\r\n */\r\nconst Name = \"Statics\";\r\n\r\nexport { Name as name };\r\n\r\n/**\r\n * Creates a stack panel that can be used to render headers\r\n * @param control defines the control to associate with the header\r\n * @param text defines the text of the header\r\n * @param size defines the size of the header\r\n * @param options defines options used to configure the header\r\n * @param options.isHorizontal\r\n * @param options.controlFirst\r\n * @returns a new StackPanel\r\n */\r\nControl.AddHeader = function (control: Control, text: string, size: string | number, options: { isHorizontal: boolean; controlFirst: boolean }): StackPanel {\r\n    const panel = new StackPanel(\"panel\");\r\n    const isHorizontal = options ? options.isHorizontal : true;\r\n    const controlFirst = options ? options.controlFirst : true;\r\n\r\n    panel.isVertical = !isHorizontal;\r\n\r\n    const header = new TextBlock(\"header\");\r\n    header.text = text;\r\n    header.textHorizontalAlignment = Control.HORIZONTAL_ALIGNMENT_LEFT;\r\n    if (isHorizontal) {\r\n        header.width = size;\r\n    } else {\r\n        header.height = size;\r\n    }\r\n\r\n    if (controlFirst) {\r\n        panel.addControl(control);\r\n        panel.addControl(header);\r\n        header.paddingLeft = \"5px\";\r\n    } else {\r\n        panel.addControl(header);\r\n        panel.addControl(control);\r\n        header.paddingRight = \"5px\";\r\n    }\r\n\r\n    header.shadowBlur = control.shadowBlur;\r\n    header.shadowColor = control.shadowColor;\r\n    header.shadowOffsetX = control.shadowOffsetX;\r\n    header.shadowOffsetY = control.shadowOffsetY;\r\n\r\n    return panel;\r\n};\r\n"]}

package/2D/controls/textBlock.d.ts

@@ -0,0 +1,219 @@
+import { Observable } from "@babylonjs/core/Misc/observable.js";
+import type { Measure } from "../measure.js";
+import { Control } from "./control.js";
+import type { Nullable } from "@babylonjs/core/types.js";
+import type { ICanvasRenderingContext } from "@babylonjs/core/Engines/ICanvas.js";
+/**
+ * Enum that determines the text-wrapping mode to use.
+ */
+export declare const enum TextWrapping {
+    /**
+     * Clip the text when it's larger than Control.width; this is the default mode.
+     */
+    Clip = 0,
+    /**
+     * Wrap the text word-wise, i.e. try to add line-breaks at word boundary to fit within Control.width.
+     */
+    WordWrap = 1,
+    /**
+     * Ellipsize the text, i.e. shrink with trailing … when text is larger than Control.width.
+     */
+    Ellipsis = 2,
+    /**
+     * Wrap the text word-wise and clip the text when the text's height is larger than the Control.height, and shrink the last line with trailing … .
+     */
+    WordWrapEllipsis = 3,
+    /**
+     * Use HTML to wrap the text. This is the only mode that supports east-asian languages.
+     */
+    HTML = 4
+}
+/**
+ * Class used to create text block control
+ */
+export declare class TextBlock extends Control {
+    /**
+     * Defines the name of the control
+     */
+    name?: string | undefined;
+    private _text;
+    private _textWrapping;
+    private _textHorizontalAlignment;
+    private _textVerticalAlignment;
+    private _lines;
+    private _resizeToFit;
+    private _lineSpacing;
+    private _outlineWidth;
+    private _outlineColor;
+    private _underline;
+    private _lineThrough;
+    private _wordDivider;
+    private _forceResizeWidth;
+    private _applyOutlineToUnderline;
+    /**
+     * An event triggered after the text is changed
+     */
+    onTextChangedObservable: Observable<TextBlock>;
+    /**
+     * An event triggered after the text was broken up into lines
+     */
+    onLinesReadyObservable: Observable<TextBlock>;
+    /**
+     * Function used to split a string into words. By default, a string is split at each space character found
+     */
+    wordSplittingFunction: Nullable<(line: string) => string[]>;
+    /**
+     * This function will be called when a new HTML element is generated to be used for word wrapping.
+     * This is only used when wrapping mode HTML is selected.
+     * Using this function you can adjust word-break, overflow-wrap, hyphens, or any other CSS properties of the HTML element, language-dependent.
+     */
+    adjustWordWrappingHTMLElement: Nullable<(element: HTMLElement) => void>;
+    /**
+     * Gets or sets a boolean indicating if the HTML element generated for word wrapping should be reused or removed after each wrapping.
+     */
+    reuseHTMLForWordWrapping: boolean;
+    /**
+     * Return the line list (you may need to use the onLinesReadyObservable to make sure the list is ready)
+     */
+    get lines(): any[];
+    /**
+     * Gets or sets a boolean indicating that the TextBlock will be resized to fit its content
+
+     */
+    get resizeToFit(): boolean;
+    /**
+     * Gets or sets a boolean indicating that the TextBlock will be resized to fit its content
+
+     */
+    set resizeToFit(value: boolean);
+    /**
+     * Gets or sets a boolean indicating if text must be wrapped
+     */
+    get textWrapping(): TextWrapping | boolean;
+    /**
+     * Gets or sets a boolean indicating if text must be wrapped
+     */
+    set textWrapping(value: TextWrapping | boolean);
+    /**
+     * Gets or sets text to display
+     */
+    get text(): string;
+    /**
+     * Gets or sets text to display
+     */
+    set text(value: string);
+    /**
+     * Gets or sets text horizontal alignment (BABYLON.GUI.Control.HORIZONTAL_ALIGNMENT_CENTER by default)
+     */
+    get textHorizontalAlignment(): number;
+    /**
+     * Gets or sets text horizontal alignment (BABYLON.GUI.Control.HORIZONTAL_ALIGNMENT_CENTER by default)
+     */
+    set textHorizontalAlignment(value: number);
+    /**
+     * Gets or sets text vertical alignment (BABYLON.GUI.Control.VERTICAL_ALIGNMENT_CENTER by default)
+     */
+    get textVerticalAlignment(): number;
+    /**
+     * Gets or sets text vertical alignment (BABYLON.GUI.Control.VERTICAL_ALIGNMENT_CENTER by default)
+     */
+    set textVerticalAlignment(value: number);
+    /**
+     * Gets or sets line spacing value
+     */
+    set lineSpacing(value: string | number);
+    /**
+     * Gets or sets line spacing value
+     */
+    get lineSpacing(): string | number;
+    /**
+     * Gets or sets outlineWidth of the text to display
+     */
+    get outlineWidth(): number;
+    /**
+     * Gets or sets outlineWidth of the text to display
+     */
+    set outlineWidth(value: number);
+    /**
+     * Gets or sets a boolean indicating that text must have underline
+     */
+    get underline(): boolean;
+    /**
+     * Gets or sets a boolean indicating that text must have underline
+     */
+    set underline(value: boolean);
+    /**
+     * Gets or sets an boolean indicating that text must be crossed out
+     */
+    get lineThrough(): boolean;
+    /**
+     * Gets or sets an boolean indicating that text must be crossed out
+     */
+    set lineThrough(value: boolean);
+    /**
+     * If the outline should be applied to the underline/strike-through too. Has different behavior in Edge/Chrome vs Firefox.
+     */
+    get applyOutlineToUnderline(): boolean;
+    set applyOutlineToUnderline(value: boolean);
+    /**
+     * Gets or sets outlineColor of the text to display
+     */
+    get outlineColor(): string;
+    /**
+     * Gets or sets outlineColor of the text to display
+     */
+    set outlineColor(value: string);
+    /**
+     * Gets or sets word divider
+     */
+    get wordDivider(): string;
+    /**
+     * Gets or sets word divider
+     */
+    set wordDivider(value: string);
+    /**
+     * By default, if a text block has text wrapping other than Clip, its width
+     * is not resized even if resizeToFit = true. This parameter forces the width
+     * to be resized.
+     */
+    get forceResizeWidth(): boolean;
+    set forceResizeWidth(value: boolean);
+    /**
+     * Creates a new TextBlock object
+     * @param name defines the name of the control
+     * @param text defines the text to display (empty string by default)
+     */
+    constructor(
+    /**
+     * Defines the name of the control
+     */
+    name?: string | undefined, text?: string);
+    protected _getTypeName(): string;
+    protected _processMeasures(parentMeasure: Measure, context: ICanvasRenderingContext): void;
+    private _drawText;
+    private _drawLine;
+    /**
+     * @internal
+     */
+    _draw(context: ICanvasRenderingContext): void;
+    protected _applyStates(context: ICanvasRenderingContext): void;
+    private _linesTemp;
+    protected _breakLines(refWidth: number, refHeight: number, context: ICanvasRenderingContext): object[];
+    private _htmlElement;
+    protected _parseHTMLText(refWidth: number, refHeight: number, context: ICanvasRenderingContext): string[];
+    protected _parseLine(line: string | undefined, context: ICanvasRenderingContext): object;
+    private _getCharsToRemove;
+    protected _parseLineEllipsis(line: string | undefined, width: number, context: ICanvasRenderingContext): object;
+    private _getTextMetricsWidth;
+    protected _parseLineWordWrap(line: string | undefined, width: number, context: ICanvasRenderingContext): object[];
+    protected _parseLineWordWrapEllipsis(line: string | undefined, width: number, height: number, context: ICanvasRenderingContext): object[];
+    protected _renderLines(context: ICanvasRenderingContext): void;
+    private _computeHeightForLinesOf;
+    isDimensionFullyDefined(dim: "width" | "height"): boolean;
+    /**
+     * Given a width constraint applied on the text block, find the expected height
+     * @returns expected height
+     */
+    computeExpectedHeight(): number;
+    dispose(): void;
+}