@babylonjs/gui 5.0.0-rc.7 → 5.0.0-rc.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/2D/adtInstrumentation.d.ts +52 -52
- package/2D/adtInstrumentation.js +126 -126
- package/2D/advancedDynamicTexture.d.ts +448 -448
- package/2D/advancedDynamicTexture.js +1318 -1318
- package/2D/controls/button.d.ts +135 -135
- package/2D/controls/button.js +276 -276
- package/2D/controls/checkbox.d.ts +59 -59
- package/2D/controls/checkbox.js +188 -188
- package/2D/controls/colorpicker.d.ts +103 -103
- package/2D/controls/colorpicker.js +1417 -1417
- package/2D/controls/container.d.ts +175 -175
- package/2D/controls/container.js +570 -570
- package/2D/controls/control.d.ts +866 -866
- package/2D/controls/control.js +2433 -2433
- package/2D/controls/displayGrid.d.ts +53 -53
- package/2D/controls/displayGrid.js +245 -245
- package/2D/controls/ellipse.d.ts +21 -21
- package/2D/controls/ellipse.js +85 -85
- package/2D/controls/focusableButton.d.ts +59 -59
- package/2D/controls/focusableButton.js +99 -99
- package/2D/controls/focusableControl.d.ts +34 -34
- package/2D/controls/focusableControl.js +1 -1
- package/2D/controls/grid.d.ts +139 -139
- package/2D/controls/grid.js +529 -529
- package/2D/controls/image.d.ts +204 -204
- package/2D/controls/image.js +887 -887
- package/2D/controls/index.d.ts +29 -29
- package/2D/controls/index.js +29 -29
- package/2D/controls/inputPassword.d.ts +8 -8
- package/2D/controls/inputPassword.js +25 -25
- package/2D/controls/inputText.d.ts +201 -201
- package/2D/controls/inputText.js +1119 -1119
- package/2D/controls/line.d.ts +66 -66
- package/2D/controls/line.js +271 -271
- package/2D/controls/multiLine.d.ts +75 -75
- package/2D/controls/multiLine.js +262 -262
- package/2D/controls/radioButton.d.ts +49 -49
- package/2D/controls/radioButton.js +205 -205
- package/2D/controls/rectangle.d.ts +29 -29
- package/2D/controls/rectangle.js +150 -150
- package/2D/controls/scrollViewers/scrollViewer.d.ts +182 -182
- package/2D/controls/scrollViewers/scrollViewer.js +677 -677
- package/2D/controls/scrollViewers/scrollViewerWindow.d.ts +57 -57
- package/2D/controls/scrollViewers/scrollViewerWindow.js +278 -278
- package/2D/controls/selector.d.ts +263 -263
- package/2D/controls/selector.js +692 -692
- package/2D/controls/sliders/baseSlider.d.ts +82 -82
- package/2D/controls/sliders/baseSlider.js +347 -347
- package/2D/controls/sliders/imageBasedSlider.d.ts +49 -49
- package/2D/controls/sliders/imageBasedSlider.js +192 -192
- package/2D/controls/sliders/imageScrollBar.d.ts +65 -65
- package/2D/controls/sliders/imageScrollBar.js +263 -263
- package/2D/controls/sliders/scrollBar.d.ts +38 -38
- package/2D/controls/sliders/scrollBar.js +143 -143
- package/2D/controls/sliders/slider.d.ts +35 -35
- package/2D/controls/sliders/slider.js +271 -271
- package/2D/controls/stackPanel.d.ts +64 -64
- package/2D/controls/stackPanel.js +246 -246
- package/2D/controls/statics.d.ts +6 -6
- package/2D/controls/statics.js +49 -49
- package/2D/controls/textBlock.d.ts +175 -175
- package/2D/controls/textBlock.js +603 -603
- package/2D/controls/textWrapper.d.ts +13 -13
- package/2D/controls/textWrapper.js +101 -101
- package/2D/controls/toggleButton.d.ts +117 -117
- package/2D/controls/toggleButton.js +268 -268
- package/2D/controls/virtualKeyboard.d.ts +96 -96
- package/2D/controls/virtualKeyboard.js +256 -256
- package/2D/index.d.ts +9 -9
- package/2D/index.js +9 -9
- package/2D/math2D.d.ts +117 -117
- package/2D/math2D.js +221 -221
- package/2D/measure.d.ts +77 -77
- package/2D/measure.js +139 -139
- package/2D/multiLinePoint.d.ts +47 -47
- package/2D/multiLinePoint.js +127 -127
- package/2D/style.d.ts +46 -46
- package/2D/style.js +97 -97
- package/2D/valueAndUnit.d.ts +89 -89
- package/2D/valueAndUnit.js +226 -226
- package/2D/xmlLoader.d.ts +60 -60
- package/2D/xmlLoader.js +348 -348
- package/3D/behaviors/defaultBehavior.d.ts +73 -73
- package/3D/behaviors/defaultBehavior.js +121 -121
- package/3D/controls/abstractButton3D.d.ts +15 -15
- package/3D/controls/abstractButton3D.js +25 -25
- package/3D/controls/button3D.d.ts +30 -30
- package/3D/controls/button3D.js +93 -93
- package/3D/controls/container3D.d.ts +72 -72
- package/3D/controls/container3D.js +139 -139
- package/3D/controls/contentDisplay3D.d.ts +30 -30
- package/3D/controls/contentDisplay3D.js +79 -79
- package/3D/controls/control3D.d.ts +201 -201
- package/3D/controls/control3D.js +445 -445
- package/3D/controls/cylinderPanel.d.ts +17 -17
- package/3D/controls/cylinderPanel.js +66 -66
- package/3D/controls/handMenu.d.ts +28 -28
- package/3D/controls/handMenu.js +47 -47
- package/3D/controls/holographicBackplate.d.ts +49 -49
- package/3D/controls/holographicBackplate.js +120 -120
- package/3D/controls/holographicButton.d.ts +84 -84
- package/3D/controls/holographicButton.js +339 -339
- package/3D/controls/holographicSlate.d.ts +131 -131
- package/3D/controls/holographicSlate.js +431 -431
- package/3D/controls/index.d.ts +21 -21
- package/3D/controls/index.js +21 -21
- package/3D/controls/meshButton3D.d.ts +21 -21
- package/3D/controls/meshButton3D.js +62 -62
- package/3D/controls/nearMenu.d.ts +44 -44
- package/3D/controls/nearMenu.js +114 -114
- package/3D/controls/planePanel.d.ts +9 -9
- package/3D/controls/planePanel.js +36 -36
- package/3D/controls/scatterPanel.d.ts +18 -18
- package/3D/controls/scatterPanel.js +108 -108
- package/3D/controls/slider3D.d.ts +81 -81
- package/3D/controls/slider3D.js +268 -268
- package/3D/controls/spherePanel.d.ts +17 -17
- package/3D/controls/spherePanel.js +67 -67
- package/3D/controls/stackPanel3D.d.ts +22 -22
- package/3D/controls/stackPanel3D.js +107 -107
- package/3D/controls/touchButton3D.d.ts +80 -80
- package/3D/controls/touchButton3D.js +233 -233
- package/3D/controls/touchHolographicButton.d.ts +110 -110
- package/3D/controls/touchHolographicButton.js +445 -445
- package/3D/controls/touchHolographicMenu.d.ts +61 -61
- package/3D/controls/touchHolographicMenu.js +149 -149
- package/3D/controls/touchMeshButton3D.d.ts +21 -21
- package/3D/controls/touchMeshButton3D.js +62 -62
- package/3D/controls/volumeBasedPanel.d.ts +53 -53
- package/3D/controls/volumeBasedPanel.js +174 -174
- package/3D/gizmos/gizmoHandle.d.ts +108 -108
- package/3D/gizmos/gizmoHandle.js +209 -209
- package/3D/gizmos/index.d.ts +2 -2
- package/3D/gizmos/index.js +2 -2
- package/3D/gizmos/slateGizmo.d.ts +57 -57
- package/3D/gizmos/slateGizmo.js +369 -369
- package/3D/gui3DManager.d.ts +94 -94
- package/3D/gui3DManager.js +257 -257
- package/3D/index.d.ts +5 -5
- package/3D/index.js +5 -5
- package/3D/materials/fluent/fluentMaterial.d.ts +90 -90
- package/3D/materials/fluent/fluentMaterial.js +292 -292
- package/3D/materials/fluent/index.d.ts +1 -1
- package/3D/materials/fluent/index.js +1 -1
- package/3D/materials/fluent/shaders/fluent.fragment.d.ts +5 -5
- package/3D/materials/fluent/shaders/fluent.fragment.js +8 -8
- package/3D/materials/fluent/shaders/fluent.vertex.d.ts +5 -5
- package/3D/materials/fluent/shaders/fluent.vertex.js +8 -8
- package/3D/materials/fluentBackplate/fluentBackplateMaterial.d.ts +154 -154
- package/3D/materials/fluentBackplate/fluentBackplateMaterial.js +469 -469
- package/3D/materials/fluentBackplate/index.d.ts +1 -1
- package/3D/materials/fluentBackplate/index.js +1 -1
- package/3D/materials/fluentBackplate/shaders/fluentBackplate.fragment.d.ts +5 -5
- package/3D/materials/fluentBackplate/shaders/fluentBackplate.fragment.js +8 -8
- package/3D/materials/fluentBackplate/shaders/fluentBackplate.vertex.d.ts +5 -5
- package/3D/materials/fluentBackplate/shaders/fluentBackplate.vertex.js +8 -8
- package/3D/materials/fluentButton/fluentButtonMaterial.d.ts +189 -189
- package/3D/materials/fluentButton/fluentButtonMaterial.js +539 -539
- package/3D/materials/fluentButton/index.d.ts +1 -1
- package/3D/materials/fluentButton/index.js +1 -1
- package/3D/materials/fluentButton/shaders/fluentButton.fragment.d.ts +5 -5
- package/3D/materials/fluentButton/shaders/fluentButton.fragment.js +8 -8
- package/3D/materials/fluentButton/shaders/fluentButton.vertex.d.ts +5 -5
- package/3D/materials/fluentButton/shaders/fluentButton.vertex.js +8 -8
- package/3D/materials/fluentMaterial.d.ts +4 -4
- package/3D/materials/fluentMaterial.js +4 -4
- package/3D/materials/handle/handleMaterial.d.ts +68 -68
- package/3D/materials/handle/handleMaterial.js +126 -126
- package/3D/materials/handle/index.d.ts +1 -1
- package/3D/materials/handle/index.js +1 -1
- package/3D/materials/handle/shaders/handle.fragment.d.ts +5 -5
- package/3D/materials/handle/shaders/handle.fragment.js +8 -8
- package/3D/materials/handle/shaders/handle.vertex.d.ts +5 -5
- package/3D/materials/handle/shaders/handle.vertex.js +8 -8
- package/3D/materials/index.d.ts +5 -5
- package/3D/materials/index.js +5 -5
- package/3D/materials/mrdl/index.d.ts +3 -3
- package/3D/materials/mrdl/index.js +3 -3
- package/3D/materials/mrdl/mrdlBackplateMaterial.d.ts +147 -147
- package/3D/materials/mrdl/mrdlBackplateMaterial.js +436 -436
- package/3D/materials/mrdl/mrdlSliderBarMaterial.d.ts +333 -333
- package/3D/materials/mrdl/mrdlSliderBarMaterial.js +851 -851
- package/3D/materials/mrdl/mrdlSliderThumbMaterial.d.ts +333 -333
- package/3D/materials/mrdl/mrdlSliderThumbMaterial.js +851 -851
- package/3D/materials/mrdl/shaders/mrdlBackplate.fragment.d.ts +5 -5
- package/3D/materials/mrdl/shaders/mrdlBackplate.fragment.js +8 -8
- package/3D/materials/mrdl/shaders/mrdlBackplate.vertex.d.ts +5 -5
- package/3D/materials/mrdl/shaders/mrdlBackplate.vertex.js +8 -8
- package/3D/materials/mrdl/shaders/mrdlSliderBar.fragment.d.ts +5 -5
- package/3D/materials/mrdl/shaders/mrdlSliderBar.fragment.js +8 -8
- package/3D/materials/mrdl/shaders/mrdlSliderBar.vertex.d.ts +5 -5
- package/3D/materials/mrdl/shaders/mrdlSliderBar.vertex.js +8 -8
- package/3D/materials/mrdl/shaders/mrdlSliderThumb.fragment.d.ts +5 -5
- package/3D/materials/mrdl/shaders/mrdlSliderThumb.fragment.js +8 -8
- package/3D/materials/mrdl/shaders/mrdlSliderThumb.vertex.d.ts +5 -5
- package/3D/materials/mrdl/shaders/mrdlSliderThumb.vertex.js +8 -8
- package/3D/vector3WithInfo.d.ts +16 -16
- package/3D/vector3WithInfo.js +23 -23
- package/index.d.ts +2 -2
- package/index.js +2 -2
- package/legacy/legacy.d.ts +1 -1
- package/legacy/legacy.js +13 -13
- package/package.json +2 -2
package/2D/controls/statics.js
CHANGED
|
@@ -1,50 +1,50 @@
|
|
|
1
|
-
import { Control } from "./control
|
|
2
|
-
import { StackPanel } from "./stackPanel
|
|
3
|
-
import { TextBlock } from "./textBlock
|
|
4
|
-
/**
|
|
5
|
-
* Forcing an export so that this code will execute
|
|
6
|
-
* @hidden
|
|
7
|
-
*/
|
|
8
|
-
var name = "Statics";
|
|
9
|
-
export { name };
|
|
10
|
-
/**
|
|
11
|
-
* Creates a stack panel that can be used to render headers
|
|
12
|
-
* @param control defines the control to associate with the header
|
|
13
|
-
* @param text defines the text of the header
|
|
14
|
-
* @param size defines the size of the header
|
|
15
|
-
* @param options defines options used to configure the header
|
|
16
|
-
* @param options.isHorizontal
|
|
17
|
-
* @param options.controlFirst
|
|
18
|
-
* @returns a new StackPanel
|
|
19
|
-
*/
|
|
20
|
-
Control.AddHeader = function (control, text, size, options) {
|
|
21
|
-
var panel = new StackPanel("panel");
|
|
22
|
-
var isHorizontal = options ? options.isHorizontal : true;
|
|
23
|
-
var controlFirst = options ? options.controlFirst : true;
|
|
24
|
-
panel.isVertical = !isHorizontal;
|
|
25
|
-
var header = new TextBlock("header");
|
|
26
|
-
header.text = text;
|
|
27
|
-
header.textHorizontalAlignment = Control.HORIZONTAL_ALIGNMENT_LEFT;
|
|
28
|
-
if (isHorizontal) {
|
|
29
|
-
header.width = size;
|
|
30
|
-
}
|
|
31
|
-
else {
|
|
32
|
-
header.height = size;
|
|
33
|
-
}
|
|
34
|
-
if (controlFirst) {
|
|
35
|
-
panel.addControl(control);
|
|
36
|
-
panel.addControl(header);
|
|
37
|
-
header.paddingLeft = "5px";
|
|
38
|
-
}
|
|
39
|
-
else {
|
|
40
|
-
panel.addControl(header);
|
|
41
|
-
panel.addControl(control);
|
|
42
|
-
header.paddingRight = "5px";
|
|
43
|
-
}
|
|
44
|
-
header.shadowBlur = control.shadowBlur;
|
|
45
|
-
header.shadowColor = control.shadowColor;
|
|
46
|
-
header.shadowOffsetX = control.shadowOffsetX;
|
|
47
|
-
header.shadowOffsetY = control.shadowOffsetY;
|
|
48
|
-
return panel;
|
|
49
|
-
};
|
|
1
|
+
import { Control } from "./control";
|
|
2
|
+
import { StackPanel } from "./stackPanel";
|
|
3
|
+
import { TextBlock } from "./textBlock";
|
|
4
|
+
/**
|
|
5
|
+
* Forcing an export so that this code will execute
|
|
6
|
+
* @hidden
|
|
7
|
+
*/
|
|
8
|
+
var name = "Statics";
|
|
9
|
+
export { name };
|
|
10
|
+
/**
|
|
11
|
+
* Creates a stack panel that can be used to render headers
|
|
12
|
+
* @param control defines the control to associate with the header
|
|
13
|
+
* @param text defines the text of the header
|
|
14
|
+
* @param size defines the size of the header
|
|
15
|
+
* @param options defines options used to configure the header
|
|
16
|
+
* @param options.isHorizontal
|
|
17
|
+
* @param options.controlFirst
|
|
18
|
+
* @returns a new StackPanel
|
|
19
|
+
*/
|
|
20
|
+
Control.AddHeader = function (control, text, size, options) {
|
|
21
|
+
var panel = new StackPanel("panel");
|
|
22
|
+
var isHorizontal = options ? options.isHorizontal : true;
|
|
23
|
+
var controlFirst = options ? options.controlFirst : true;
|
|
24
|
+
panel.isVertical = !isHorizontal;
|
|
25
|
+
var header = new TextBlock("header");
|
|
26
|
+
header.text = text;
|
|
27
|
+
header.textHorizontalAlignment = Control.HORIZONTAL_ALIGNMENT_LEFT;
|
|
28
|
+
if (isHorizontal) {
|
|
29
|
+
header.width = size;
|
|
30
|
+
}
|
|
31
|
+
else {
|
|
32
|
+
header.height = size;
|
|
33
|
+
}
|
|
34
|
+
if (controlFirst) {
|
|
35
|
+
panel.addControl(control);
|
|
36
|
+
panel.addControl(header);
|
|
37
|
+
header.paddingLeft = "5px";
|
|
38
|
+
}
|
|
39
|
+
else {
|
|
40
|
+
panel.addControl(header);
|
|
41
|
+
panel.addControl(control);
|
|
42
|
+
header.paddingRight = "5px";
|
|
43
|
+
}
|
|
44
|
+
header.shadowBlur = control.shadowBlur;
|
|
45
|
+
header.shadowColor = control.shadowColor;
|
|
46
|
+
header.shadowOffsetX = control.shadowOffsetX;
|
|
47
|
+
header.shadowOffsetY = control.shadowOffsetY;
|
|
48
|
+
return panel;
|
|
49
|
+
};
|
|
50
50
|
//# sourceMappingURL=statics.js.map
|
|
@@ -1,175 +1,175 @@
|
|
|
1
|
-
import { Observable } from "@babylonjs/core/Misc/observable.js";
|
|
2
|
-
import { Measure } from "../measure";
|
|
3
|
-
import { Control } from "./control";
|
|
4
|
-
import { Nullable } from "@babylonjs/core/types.js";
|
|
5
|
-
import { ICanvasRenderingContext } from "@babylonjs/core/Engines/ICanvas.js";
|
|
6
|
-
/**
|
|
7
|
-
* Enum that determines the text-wrapping mode to use.
|
|
8
|
-
*/
|
|
9
|
-
export declare enum TextWrapping {
|
|
10
|
-
/**
|
|
11
|
-
* Clip the text when it's larger than Control.width; this is the default mode.
|
|
12
|
-
*/
|
|
13
|
-
Clip = 0,
|
|
14
|
-
/**
|
|
15
|
-
* Wrap the text word-wise, i.e. try to add line-breaks at word boundary to fit within Control.width.
|
|
16
|
-
*/
|
|
17
|
-
WordWrap = 1,
|
|
18
|
-
/**
|
|
19
|
-
* Ellipsize the text, i.e. shrink with trailing … when text is larger than Control.width.
|
|
20
|
-
*/
|
|
21
|
-
Ellipsis = 2,
|
|
22
|
-
/**
|
|
23
|
-
* 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 … .
|
|
24
|
-
*/
|
|
25
|
-
WordWrapEllipsis = 3
|
|
26
|
-
}
|
|
27
|
-
/**
|
|
28
|
-
* Class used to create text block control
|
|
29
|
-
*/
|
|
30
|
-
export declare class TextBlock extends Control {
|
|
31
|
-
/**
|
|
32
|
-
* Defines the name of the control
|
|
33
|
-
*/
|
|
34
|
-
name?: string | undefined;
|
|
35
|
-
private _text;
|
|
36
|
-
private _textWrapping;
|
|
37
|
-
private _textHorizontalAlignment;
|
|
38
|
-
private _textVerticalAlignment;
|
|
39
|
-
private _lines;
|
|
40
|
-
private _resizeToFit;
|
|
41
|
-
private _lineSpacing;
|
|
42
|
-
private _outlineWidth;
|
|
43
|
-
private _outlineColor;
|
|
44
|
-
private _underline;
|
|
45
|
-
private _lineThrough;
|
|
46
|
-
/**
|
|
47
|
-
* An event triggered after the text is changed
|
|
48
|
-
*/
|
|
49
|
-
onTextChangedObservable: Observable<TextBlock>;
|
|
50
|
-
/**
|
|
51
|
-
* An event triggered after the text was broken up into lines
|
|
52
|
-
*/
|
|
53
|
-
onLinesReadyObservable: Observable<TextBlock>;
|
|
54
|
-
/**
|
|
55
|
-
* Function used to split a string into words. By default, a string is split at each space character found
|
|
56
|
-
*/
|
|
57
|
-
wordSplittingFunction: Nullable<(line: string) => string[]>;
|
|
58
|
-
/**
|
|
59
|
-
* Return the line list (you may need to use the onLinesReadyObservable to make sure the list is ready)
|
|
60
|
-
*/
|
|
61
|
-
get lines(): any[];
|
|
62
|
-
/**
|
|
63
|
-
* Gets or sets an boolean indicating that the TextBlock will be resized to fit container
|
|
64
|
-
*/
|
|
65
|
-
get resizeToFit(): boolean;
|
|
66
|
-
/**
|
|
67
|
-
* Gets or sets an boolean indicating that the TextBlock will be resized to fit container
|
|
68
|
-
*/
|
|
69
|
-
set resizeToFit(value: boolean);
|
|
70
|
-
/**
|
|
71
|
-
* Gets or sets a boolean indicating if text must be wrapped
|
|
72
|
-
*/
|
|
73
|
-
get textWrapping(): TextWrapping | boolean;
|
|
74
|
-
/**
|
|
75
|
-
* Gets or sets a boolean indicating if text must be wrapped
|
|
76
|
-
*/
|
|
77
|
-
set textWrapping(value: TextWrapping | boolean);
|
|
78
|
-
/**
|
|
79
|
-
* Gets or sets text to display
|
|
80
|
-
*/
|
|
81
|
-
get text(): string;
|
|
82
|
-
/**
|
|
83
|
-
* Gets or sets text to display
|
|
84
|
-
*/
|
|
85
|
-
set text(value: string);
|
|
86
|
-
/**
|
|
87
|
-
* Gets or sets text horizontal alignment (BABYLON.GUI.Control.HORIZONTAL_ALIGNMENT_CENTER by default)
|
|
88
|
-
*/
|
|
89
|
-
get textHorizontalAlignment(): number;
|
|
90
|
-
/**
|
|
91
|
-
* Gets or sets text horizontal alignment (BABYLON.GUI.Control.HORIZONTAL_ALIGNMENT_CENTER by default)
|
|
92
|
-
*/
|
|
93
|
-
set textHorizontalAlignment(value: number);
|
|
94
|
-
/**
|
|
95
|
-
* Gets or sets text vertical alignment (BABYLON.GUI.Control.VERTICAL_ALIGNMENT_CENTER by default)
|
|
96
|
-
*/
|
|
97
|
-
get textVerticalAlignment(): number;
|
|
98
|
-
/**
|
|
99
|
-
* Gets or sets text vertical alignment (BABYLON.GUI.Control.VERTICAL_ALIGNMENT_CENTER by default)
|
|
100
|
-
*/
|
|
101
|
-
set textVerticalAlignment(value: number);
|
|
102
|
-
/**
|
|
103
|
-
* Gets or sets line spacing value
|
|
104
|
-
*/
|
|
105
|
-
set lineSpacing(value: string | number);
|
|
106
|
-
/**
|
|
107
|
-
* Gets or sets line spacing value
|
|
108
|
-
*/
|
|
109
|
-
get lineSpacing(): string | number;
|
|
110
|
-
/**
|
|
111
|
-
* Gets or sets outlineWidth of the text to display
|
|
112
|
-
*/
|
|
113
|
-
get outlineWidth(): number;
|
|
114
|
-
/**
|
|
115
|
-
* Gets or sets outlineWidth of the text to display
|
|
116
|
-
*/
|
|
117
|
-
set outlineWidth(value: number);
|
|
118
|
-
/**
|
|
119
|
-
* Gets or sets a boolean indicating that text must have underline
|
|
120
|
-
*/
|
|
121
|
-
get underline(): boolean;
|
|
122
|
-
/**
|
|
123
|
-
* Gets or sets a boolean indicating that text must have underline
|
|
124
|
-
*/
|
|
125
|
-
set underline(value: boolean);
|
|
126
|
-
/**
|
|
127
|
-
* Gets or sets an boolean indicating that text must be crossed out
|
|
128
|
-
*/
|
|
129
|
-
get lineThrough(): boolean;
|
|
130
|
-
/**
|
|
131
|
-
* Gets or sets an boolean indicating that text must be crossed out
|
|
132
|
-
*/
|
|
133
|
-
set lineThrough(value: boolean);
|
|
134
|
-
/**
|
|
135
|
-
* Gets or sets outlineColor of the text to display
|
|
136
|
-
*/
|
|
137
|
-
get outlineColor(): string;
|
|
138
|
-
/**
|
|
139
|
-
* Gets or sets outlineColor of the text to display
|
|
140
|
-
*/
|
|
141
|
-
set outlineColor(value: string);
|
|
142
|
-
/**
|
|
143
|
-
* Creates a new TextBlock object
|
|
144
|
-
* @param name defines the name of the control
|
|
145
|
-
* @param text defines the text to display (empty string by default)
|
|
146
|
-
*/
|
|
147
|
-
constructor(
|
|
148
|
-
/**
|
|
149
|
-
* Defines the name of the control
|
|
150
|
-
*/
|
|
151
|
-
name?: string | undefined, text?: string);
|
|
152
|
-
protected _getTypeName(): string;
|
|
153
|
-
protected _processMeasures(parentMeasure: Measure, context: ICanvasRenderingContext): void;
|
|
154
|
-
private _drawText;
|
|
155
|
-
/**
|
|
156
|
-
* @param context
|
|
157
|
-
* @hidden
|
|
158
|
-
*/
|
|
159
|
-
_draw(context: ICanvasRenderingContext): void;
|
|
160
|
-
protected _applyStates(context: ICanvasRenderingContext): void;
|
|
161
|
-
protected _breakLines(refWidth: number, refHeight: number, context: ICanvasRenderingContext): object[];
|
|
162
|
-
protected _parseLine(line: string | undefined, context: ICanvasRenderingContext): object;
|
|
163
|
-
private _getCharsToRemove;
|
|
164
|
-
protected _parseLineEllipsis(line: string | undefined, width: number, context: ICanvasRenderingContext): object;
|
|
165
|
-
protected _parseLineWordWrap(line: string | undefined, width: number, context: ICanvasRenderingContext): object[];
|
|
166
|
-
protected _parseLineWordWrapEllipsis(line: string | undefined, width: number, height: number, context: ICanvasRenderingContext): object[];
|
|
167
|
-
protected _renderLines(context: ICanvasRenderingContext): void;
|
|
168
|
-
private _computeHeightForLinesOf;
|
|
169
|
-
/**
|
|
170
|
-
* Given a width constraint applied on the text block, find the expected height
|
|
171
|
-
* @returns expected height
|
|
172
|
-
*/
|
|
173
|
-
computeExpectedHeight(): number;
|
|
174
|
-
dispose(): void;
|
|
175
|
-
}
|
|
1
|
+
import { Observable } from "@babylonjs/core/Misc/observable.js";
|
|
2
|
+
import { Measure } from "../measure";
|
|
3
|
+
import { Control } from "./control";
|
|
4
|
+
import { Nullable } from "@babylonjs/core/types.js";
|
|
5
|
+
import { ICanvasRenderingContext } from "@babylonjs/core/Engines/ICanvas.js";
|
|
6
|
+
/**
|
|
7
|
+
* Enum that determines the text-wrapping mode to use.
|
|
8
|
+
*/
|
|
9
|
+
export declare enum TextWrapping {
|
|
10
|
+
/**
|
|
11
|
+
* Clip the text when it's larger than Control.width; this is the default mode.
|
|
12
|
+
*/
|
|
13
|
+
Clip = 0,
|
|
14
|
+
/**
|
|
15
|
+
* Wrap the text word-wise, i.e. try to add line-breaks at word boundary to fit within Control.width.
|
|
16
|
+
*/
|
|
17
|
+
WordWrap = 1,
|
|
18
|
+
/**
|
|
19
|
+
* Ellipsize the text, i.e. shrink with trailing … when text is larger than Control.width.
|
|
20
|
+
*/
|
|
21
|
+
Ellipsis = 2,
|
|
22
|
+
/**
|
|
23
|
+
* 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 … .
|
|
24
|
+
*/
|
|
25
|
+
WordWrapEllipsis = 3
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Class used to create text block control
|
|
29
|
+
*/
|
|
30
|
+
export declare class TextBlock extends Control {
|
|
31
|
+
/**
|
|
32
|
+
* Defines the name of the control
|
|
33
|
+
*/
|
|
34
|
+
name?: string | undefined;
|
|
35
|
+
private _text;
|
|
36
|
+
private _textWrapping;
|
|
37
|
+
private _textHorizontalAlignment;
|
|
38
|
+
private _textVerticalAlignment;
|
|
39
|
+
private _lines;
|
|
40
|
+
private _resizeToFit;
|
|
41
|
+
private _lineSpacing;
|
|
42
|
+
private _outlineWidth;
|
|
43
|
+
private _outlineColor;
|
|
44
|
+
private _underline;
|
|
45
|
+
private _lineThrough;
|
|
46
|
+
/**
|
|
47
|
+
* An event triggered after the text is changed
|
|
48
|
+
*/
|
|
49
|
+
onTextChangedObservable: Observable<TextBlock>;
|
|
50
|
+
/**
|
|
51
|
+
* An event triggered after the text was broken up into lines
|
|
52
|
+
*/
|
|
53
|
+
onLinesReadyObservable: Observable<TextBlock>;
|
|
54
|
+
/**
|
|
55
|
+
* Function used to split a string into words. By default, a string is split at each space character found
|
|
56
|
+
*/
|
|
57
|
+
wordSplittingFunction: Nullable<(line: string) => string[]>;
|
|
58
|
+
/**
|
|
59
|
+
* Return the line list (you may need to use the onLinesReadyObservable to make sure the list is ready)
|
|
60
|
+
*/
|
|
61
|
+
get lines(): any[];
|
|
62
|
+
/**
|
|
63
|
+
* Gets or sets an boolean indicating that the TextBlock will be resized to fit container
|
|
64
|
+
*/
|
|
65
|
+
get resizeToFit(): boolean;
|
|
66
|
+
/**
|
|
67
|
+
* Gets or sets an boolean indicating that the TextBlock will be resized to fit container
|
|
68
|
+
*/
|
|
69
|
+
set resizeToFit(value: boolean);
|
|
70
|
+
/**
|
|
71
|
+
* Gets or sets a boolean indicating if text must be wrapped
|
|
72
|
+
*/
|
|
73
|
+
get textWrapping(): TextWrapping | boolean;
|
|
74
|
+
/**
|
|
75
|
+
* Gets or sets a boolean indicating if text must be wrapped
|
|
76
|
+
*/
|
|
77
|
+
set textWrapping(value: TextWrapping | boolean);
|
|
78
|
+
/**
|
|
79
|
+
* Gets or sets text to display
|
|
80
|
+
*/
|
|
81
|
+
get text(): string;
|
|
82
|
+
/**
|
|
83
|
+
* Gets or sets text to display
|
|
84
|
+
*/
|
|
85
|
+
set text(value: string);
|
|
86
|
+
/**
|
|
87
|
+
* Gets or sets text horizontal alignment (BABYLON.GUI.Control.HORIZONTAL_ALIGNMENT_CENTER by default)
|
|
88
|
+
*/
|
|
89
|
+
get textHorizontalAlignment(): number;
|
|
90
|
+
/**
|
|
91
|
+
* Gets or sets text horizontal alignment (BABYLON.GUI.Control.HORIZONTAL_ALIGNMENT_CENTER by default)
|
|
92
|
+
*/
|
|
93
|
+
set textHorizontalAlignment(value: number);
|
|
94
|
+
/**
|
|
95
|
+
* Gets or sets text vertical alignment (BABYLON.GUI.Control.VERTICAL_ALIGNMENT_CENTER by default)
|
|
96
|
+
*/
|
|
97
|
+
get textVerticalAlignment(): number;
|
|
98
|
+
/**
|
|
99
|
+
* Gets or sets text vertical alignment (BABYLON.GUI.Control.VERTICAL_ALIGNMENT_CENTER by default)
|
|
100
|
+
*/
|
|
101
|
+
set textVerticalAlignment(value: number);
|
|
102
|
+
/**
|
|
103
|
+
* Gets or sets line spacing value
|
|
104
|
+
*/
|
|
105
|
+
set lineSpacing(value: string | number);
|
|
106
|
+
/**
|
|
107
|
+
* Gets or sets line spacing value
|
|
108
|
+
*/
|
|
109
|
+
get lineSpacing(): string | number;
|
|
110
|
+
/**
|
|
111
|
+
* Gets or sets outlineWidth of the text to display
|
|
112
|
+
*/
|
|
113
|
+
get outlineWidth(): number;
|
|
114
|
+
/**
|
|
115
|
+
* Gets or sets outlineWidth of the text to display
|
|
116
|
+
*/
|
|
117
|
+
set outlineWidth(value: number);
|
|
118
|
+
/**
|
|
119
|
+
* Gets or sets a boolean indicating that text must have underline
|
|
120
|
+
*/
|
|
121
|
+
get underline(): boolean;
|
|
122
|
+
/**
|
|
123
|
+
* Gets or sets a boolean indicating that text must have underline
|
|
124
|
+
*/
|
|
125
|
+
set underline(value: boolean);
|
|
126
|
+
/**
|
|
127
|
+
* Gets or sets an boolean indicating that text must be crossed out
|
|
128
|
+
*/
|
|
129
|
+
get lineThrough(): boolean;
|
|
130
|
+
/**
|
|
131
|
+
* Gets or sets an boolean indicating that text must be crossed out
|
|
132
|
+
*/
|
|
133
|
+
set lineThrough(value: boolean);
|
|
134
|
+
/**
|
|
135
|
+
* Gets or sets outlineColor of the text to display
|
|
136
|
+
*/
|
|
137
|
+
get outlineColor(): string;
|
|
138
|
+
/**
|
|
139
|
+
* Gets or sets outlineColor of the text to display
|
|
140
|
+
*/
|
|
141
|
+
set outlineColor(value: string);
|
|
142
|
+
/**
|
|
143
|
+
* Creates a new TextBlock object
|
|
144
|
+
* @param name defines the name of the control
|
|
145
|
+
* @param text defines the text to display (empty string by default)
|
|
146
|
+
*/
|
|
147
|
+
constructor(
|
|
148
|
+
/**
|
|
149
|
+
* Defines the name of the control
|
|
150
|
+
*/
|
|
151
|
+
name?: string | undefined, text?: string);
|
|
152
|
+
protected _getTypeName(): string;
|
|
153
|
+
protected _processMeasures(parentMeasure: Measure, context: ICanvasRenderingContext): void;
|
|
154
|
+
private _drawText;
|
|
155
|
+
/**
|
|
156
|
+
* @param context
|
|
157
|
+
* @hidden
|
|
158
|
+
*/
|
|
159
|
+
_draw(context: ICanvasRenderingContext): void;
|
|
160
|
+
protected _applyStates(context: ICanvasRenderingContext): void;
|
|
161
|
+
protected _breakLines(refWidth: number, refHeight: number, context: ICanvasRenderingContext): object[];
|
|
162
|
+
protected _parseLine(line: string | undefined, context: ICanvasRenderingContext): object;
|
|
163
|
+
private _getCharsToRemove;
|
|
164
|
+
protected _parseLineEllipsis(line: string | undefined, width: number, context: ICanvasRenderingContext): object;
|
|
165
|
+
protected _parseLineWordWrap(line: string | undefined, width: number, context: ICanvasRenderingContext): object[];
|
|
166
|
+
protected _parseLineWordWrapEllipsis(line: string | undefined, width: number, height: number, context: ICanvasRenderingContext): object[];
|
|
167
|
+
protected _renderLines(context: ICanvasRenderingContext): void;
|
|
168
|
+
private _computeHeightForLinesOf;
|
|
169
|
+
/**
|
|
170
|
+
* Given a width constraint applied on the text block, find the expected height
|
|
171
|
+
* @returns expected height
|
|
172
|
+
*/
|
|
173
|
+
computeExpectedHeight(): number;
|
|
174
|
+
dispose(): void;
|
|
175
|
+
}
|