babylon.gui.d.ts 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579
  1. declare module BABYLON.GUI {
  2. class AdvancedDynamicTexture extends DynamicTexture {
  3. private _isDirty;
  4. private _renderObserver;
  5. private _resizeObserver;
  6. private _pointerMoveObserver;
  7. private _pointerObserver;
  8. private _canvasBlurObserver;
  9. private _background;
  10. _rootContainer: Container;
  11. _lastControlOver: Control;
  12. _lastControlDown: Control;
  13. _capturingControl: Control;
  14. _shouldBlockPointer: boolean;
  15. _layerToDispose: Layer;
  16. _linkedControls: Control[];
  17. private _isFullscreen;
  18. private _fullscreenViewport;
  19. private _idealWidth;
  20. private _idealHeight;
  21. private _renderAtIdealSize;
  22. background: string;
  23. idealWidth: number;
  24. idealHeight: number;
  25. renderAtIdealSize: boolean;
  26. readonly layer: Layer;
  27. constructor(name: string, width: number, height: number, scene: Scene, generateMipMaps?: boolean, samplingMode?: number);
  28. executeOnAllControls(func: (control: Control) => void, container?: Container): void;
  29. markAsDirty(): void;
  30. addControl(control: Control): AdvancedDynamicTexture;
  31. removeControl(control: Control): AdvancedDynamicTexture;
  32. dispose(): void;
  33. private _onResize();
  34. _getGlobalViewport(scene: Scene): Viewport;
  35. private _checkUpdate(camera);
  36. private _render();
  37. private _doPicking(x, y, type);
  38. attach(): void;
  39. attachToMesh(mesh: AbstractMesh): void;
  40. private _attachToOnBlur(scene);
  41. static CreateForMesh(mesh: AbstractMesh, width?: number, height?: number): AdvancedDynamicTexture;
  42. static CreateFullscreenUI(name: string, foreground?: boolean, scene?: Scene): AdvancedDynamicTexture;
  43. }
  44. }
  45. declare module BABYLON.GUI {
  46. class Measure {
  47. left: number;
  48. top: number;
  49. width: number;
  50. height: number;
  51. constructor(left: number, top: number, width: number, height: number);
  52. copyFrom(other: Measure): void;
  53. isEqualsTo(other: Measure): boolean;
  54. static Empty(): Measure;
  55. }
  56. }
  57. declare module BABYLON.GUI {
  58. class Matrix2D {
  59. m: Float32Array;
  60. constructor(m00: number, m01: number, m10: number, m11: number, m20: number, m21: number);
  61. fromValues(m00: number, m01: number, m10: number, m11: number, m20: number, m21: number): Matrix2D;
  62. determinant(): number;
  63. invertToRef(result: Matrix2D): Matrix2D;
  64. multiplyToRef(other: Matrix2D, result: Matrix2D): Matrix2D;
  65. transformCoordinates(x: number, y: number, result: Vector2): Matrix2D;
  66. static Identity(): Matrix2D;
  67. static TranslationToRef(x: number, y: number, result: Matrix2D): void;
  68. static ScalingToRef(x: number, y: number, result: Matrix2D): void;
  69. static RotationToRef(angle: number, result: Matrix2D): void;
  70. private static _TempPreTranslationMatrix;
  71. private static _TempPostTranslationMatrix;
  72. private static _TempRotationMatrix;
  73. private static _TempScalingMatrix;
  74. private static _TempCompose0;
  75. private static _TempCompose1;
  76. private static _TempCompose2;
  77. static ComposeToRef(tx: number, ty: number, angle: number, scaleX: number, scaleY: number, parentMatrix: Matrix2D, result: Matrix2D): void;
  78. }
  79. }
  80. declare module BABYLON.GUI {
  81. class ValueAndUnit {
  82. unit: number;
  83. negativeValueAllowed: boolean;
  84. private _value;
  85. ignoreAdaptiveScaling: boolean;
  86. constructor(value: any, unit?: number, negativeValueAllowed?: boolean);
  87. readonly isPercentage: boolean;
  88. readonly isPixel: boolean;
  89. readonly internalValue: number;
  90. getValue(host: AdvancedDynamicTexture): number;
  91. toString(host: AdvancedDynamicTexture): string;
  92. fromString(source: string | number): boolean;
  93. private static _Regex;
  94. private static _UNITMODE_PERCENTAGE;
  95. private static _UNITMODE_PIXEL;
  96. static readonly UNITMODE_PERCENTAGE: number;
  97. static readonly UNITMODE_PIXEL: number;
  98. }
  99. }
  100. declare module BABYLON.GUI {
  101. class Control {
  102. name: string;
  103. private _alpha;
  104. private _alphaSet;
  105. private _zIndex;
  106. _root: Container;
  107. _host: AdvancedDynamicTexture;
  108. _currentMeasure: Measure;
  109. private _fontFamily;
  110. private _fontSize;
  111. private _font;
  112. _width: ValueAndUnit;
  113. _height: ValueAndUnit;
  114. private _lastMeasuredFont;
  115. protected _fontOffset: {
  116. ascent: number;
  117. height: number;
  118. descent: number;
  119. };
  120. private _color;
  121. protected _horizontalAlignment: number;
  122. protected _verticalAlignment: number;
  123. private _isDirty;
  124. private _cachedParentMeasure;
  125. private _paddingLeft;
  126. private _paddingRight;
  127. private _paddingTop;
  128. private _paddingBottom;
  129. _left: ValueAndUnit;
  130. _top: ValueAndUnit;
  131. private _scaleX;
  132. private _scaleY;
  133. private _rotation;
  134. private _transformCenterX;
  135. private _transformCenterY;
  136. private _transformMatrix;
  137. private _invertTransformMatrix;
  138. private _transformedPosition;
  139. private _isMatrixDirty;
  140. private _cachedOffsetX;
  141. private _cachedOffsetY;
  142. private _isVisible;
  143. _linkedMesh: AbstractMesh;
  144. private _fontSet;
  145. private _dummyVector2;
  146. private _downCount;
  147. private _enterCount;
  148. isHitTestVisible: boolean;
  149. isPointerBlocker: boolean;
  150. protected _linkOffsetX: ValueAndUnit;
  151. protected _linkOffsetY: ValueAndUnit;
  152. readonly typeName: string;
  153. /**
  154. * An event triggered when the pointer move over the control.
  155. * @type {BABYLON.Observable}
  156. */
  157. onPointerMoveObservable: Observable<Vector2>;
  158. /**
  159. * An event triggered when the pointer move out of the control.
  160. * @type {BABYLON.Observable}
  161. */
  162. onPointerOutObservable: Observable<Control>;
  163. /**
  164. * An event triggered when the pointer taps the control
  165. * @type {BABYLON.Observable}
  166. */
  167. onPointerDownObservable: Observable<Vector2>;
  168. /**
  169. * An event triggered when pointer up
  170. * @type {BABYLON.Observable}
  171. */
  172. onPointerUpObservable: Observable<Vector2>;
  173. /**
  174. * An event triggered when pointer enters the control
  175. * @type {BABYLON.Observable}
  176. */
  177. onPointerEnterObservable: Observable<Control>;
  178. /**
  179. * An event triggered when the control is marked as dirty
  180. * @type {BABYLON.Observable}
  181. */
  182. onDirtyObservable: Observable<Control>;
  183. alpha: number;
  184. scaleX: number;
  185. scaleY: number;
  186. rotation: number;
  187. transformCenterY: number;
  188. transformCenterX: number;
  189. horizontalAlignment: number;
  190. verticalAlignment: number;
  191. width: string | number;
  192. height: string | number;
  193. fontFamily: string;
  194. fontSize: string | number;
  195. color: string;
  196. zIndex: number;
  197. isVisible: boolean;
  198. readonly isDirty: boolean;
  199. paddingLeft: string | number;
  200. paddingRight: string | number;
  201. paddingTop: string | number;
  202. paddingBottom: string | number;
  203. left: string | number;
  204. top: string | number;
  205. linkOffsetX: string | number;
  206. linkOffsetY: string | number;
  207. readonly centerX: number;
  208. readonly centerY: number;
  209. constructor(name?: string);
  210. protected _getTypeName(): string;
  211. getLocalCoordinates(globalCoordinates: Vector2): Vector2;
  212. getLocalCoordinatesToRef(globalCoordinates: Vector2, result: Vector2): Control;
  213. moveToVector3(position: Vector3, scene: Scene): void;
  214. linkWithMesh(mesh: AbstractMesh): void;
  215. _moveToProjectedPosition(projectedPosition: Vector3): void;
  216. _markMatrixAsDirty(): void;
  217. _markAsDirty(): void;
  218. _markAllAsDirty(): void;
  219. _link(root: Container, host: AdvancedDynamicTexture): void;
  220. protected _transform(context: CanvasRenderingContext2D): void;
  221. protected _applyStates(context: CanvasRenderingContext2D): void;
  222. protected _processMeasures(parentMeasure: Measure, context: CanvasRenderingContext2D): boolean;
  223. protected _clip(context: CanvasRenderingContext2D): void;
  224. _measure(): void;
  225. protected _computeAlignment(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  226. protected _preMeasure(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  227. protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  228. _draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  229. contains(x: number, y: number): boolean;
  230. _processPicking(x: number, y: number, type: number): boolean;
  231. protected _onPointerMove(coordinates: Vector2): void;
  232. protected _onPointerEnter(): boolean;
  233. protected _onPointerOut(): void;
  234. protected _onPointerDown(coordinates: Vector2): boolean;
  235. protected _onPointerUp(coordinates: Vector2): void;
  236. forcePointerUp(): void;
  237. _processObservables(type: number, x: number, y: number): boolean;
  238. private _prepareFont();
  239. private static _HORIZONTAL_ALIGNMENT_LEFT;
  240. private static _HORIZONTAL_ALIGNMENT_RIGHT;
  241. private static _HORIZONTAL_ALIGNMENT_CENTER;
  242. private static _VERTICAL_ALIGNMENT_TOP;
  243. private static _VERTICAL_ALIGNMENT_BOTTOM;
  244. private static _VERTICAL_ALIGNMENT_CENTER;
  245. static readonly HORIZONTAL_ALIGNMENT_LEFT: number;
  246. static readonly HORIZONTAL_ALIGNMENT_RIGHT: number;
  247. static readonly HORIZONTAL_ALIGNMENT_CENTER: number;
  248. static readonly VERTICAL_ALIGNMENT_TOP: number;
  249. static readonly VERTICAL_ALIGNMENT_BOTTOM: number;
  250. static readonly VERTICAL_ALIGNMENT_CENTER: number;
  251. private static _FontHeightSizes;
  252. static _GetFontOffset(font: string): {
  253. ascent: number;
  254. height: number;
  255. descent: number;
  256. };
  257. static AddHeader(control: Control, text: string, size: string | number, options: {
  258. isHorizontal: boolean;
  259. controlFirst: boolean;
  260. }): StackPanel;
  261. protected static drawEllipse(x: number, y: number, width: number, height: number, context: CanvasRenderingContext2D): void;
  262. }
  263. }
  264. declare module BABYLON.GUI {
  265. class Container extends Control {
  266. name: string;
  267. protected _children: Control[];
  268. protected _measureForChildren: Measure;
  269. protected _background: string;
  270. background: string;
  271. readonly children: Control[];
  272. constructor(name?: string);
  273. protected _getTypeName(): string;
  274. getChildByName(name: string): Control;
  275. getChildByType(name: string, type: string): Control;
  276. containsControl(control: Control): boolean;
  277. addControl(control: Control): Container;
  278. removeControl(control: Control): Container;
  279. _reOrderControl(control: Control): void;
  280. _markMatrixAsDirty(): void;
  281. _markAllAsDirty(): void;
  282. protected _localDraw(context: CanvasRenderingContext2D): void;
  283. _link(root: Container, host: AdvancedDynamicTexture): void;
  284. _draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  285. _processPicking(x: number, y: number, type: number): boolean;
  286. protected _clipForChildren(context: CanvasRenderingContext2D): void;
  287. protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  288. }
  289. }
  290. declare module BABYLON.GUI {
  291. class StackPanel extends Container {
  292. name: string;
  293. private _isVertical;
  294. private _tempMeasureStore;
  295. isVertical: boolean;
  296. constructor(name?: string);
  297. protected _getTypeName(): string;
  298. protected _preMeasure(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  299. }
  300. }
  301. declare module BABYLON.GUI {
  302. class Rectangle extends Container {
  303. name: string;
  304. private _thickness;
  305. private _cornerRadius;
  306. thickness: number;
  307. cornerRadius: number;
  308. constructor(name?: string);
  309. protected _getTypeName(): string;
  310. protected _localDraw(context: CanvasRenderingContext2D): void;
  311. protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  312. private _drawRoundedRect(context, offset?);
  313. protected _clipForChildren(context: CanvasRenderingContext2D): void;
  314. }
  315. }
  316. declare module BABYLON.GUI {
  317. class Ellipse extends Container {
  318. name: string;
  319. private _thickness;
  320. thickness: number;
  321. constructor(name?: string);
  322. protected _getTypeName(): string;
  323. protected _localDraw(context: CanvasRenderingContext2D): void;
  324. protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  325. protected _clipForChildren(context: CanvasRenderingContext2D): void;
  326. }
  327. }
  328. declare var DOMImage: new (width?: number, height?: number) => HTMLImageElement;
  329. declare module BABYLON.GUI {
  330. class Line extends Control {
  331. name: string;
  332. private _lineWidth;
  333. private _background;
  334. private _x1;
  335. private _y1;
  336. private _x2;
  337. private _y2;
  338. private _dash;
  339. private _connectedControl;
  340. private _connectedControlDirtyObserver;
  341. dash: Array<number>;
  342. connectedControl: Control;
  343. x1: string | number;
  344. y1: string | number;
  345. x2: string | number;
  346. y2: string | number;
  347. lineWidth: number;
  348. horizontalAlignment: number;
  349. verticalAlignment: number;
  350. private readonly _effectiveX2;
  351. private readonly _effectiveY2;
  352. constructor(name?: string);
  353. protected _getTypeName(): string;
  354. _draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  355. _measure(): void;
  356. protected _computeAlignment(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  357. _moveToProjectedPosition(projectedPosition: Vector3): void;
  358. }
  359. }
  360. declare var DOMImage: new (width?: number, height?: number) => HTMLImageElement;
  361. declare module BABYLON.GUI {
  362. class Slider extends Control {
  363. name: string;
  364. private _thumbWidth;
  365. private _minimum;
  366. private _maximum;
  367. private _value;
  368. private _background;
  369. private _borderColor;
  370. private _barOffset;
  371. onValueChangedObservable: Observable<number>;
  372. borderColor: string;
  373. background: string;
  374. barOffset: string | number;
  375. thumbWidth: string | number;
  376. minimum: number;
  377. maximum: number;
  378. value: number;
  379. constructor(name?: string);
  380. protected _getTypeName(): string;
  381. _draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  382. private _pointerIsDown;
  383. private _updateValueFromPointer(x);
  384. protected _onPointerDown(coordinates: Vector2): boolean;
  385. protected _onPointerMove(coordinates: Vector2): void;
  386. protected _onPointerUp(coordinates: Vector2): void;
  387. }
  388. }
  389. declare var DOMImage: new (width?: number, height?: number) => HTMLImageElement;
  390. declare module BABYLON.GUI {
  391. class Checkbox extends Control {
  392. name: string;
  393. private _isChecked;
  394. private _background;
  395. private _checkSizeRatio;
  396. private _thickness;
  397. thickness: number;
  398. onIsCheckedChangedObservable: Observable<boolean>;
  399. checkSizeRatio: number;
  400. background: string;
  401. isChecked: boolean;
  402. constructor(name?: string);
  403. protected _getTypeName(): string;
  404. _draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  405. protected _onPointerDown(coordinates: Vector2): boolean;
  406. }
  407. }
  408. declare var DOMImage: new (width?: number, height?: number) => HTMLImageElement;
  409. declare module BABYLON.GUI {
  410. class RadioButton extends Control {
  411. name: string;
  412. private _isChecked;
  413. private _background;
  414. private _checkSizeRatio;
  415. private _thickness;
  416. thickness: number;
  417. group: string;
  418. onIsCheckedChangedObservable: Observable<boolean>;
  419. checkSizeRatio: number;
  420. background: string;
  421. isChecked: boolean;
  422. constructor(name?: string);
  423. protected _getTypeName(): string;
  424. _draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  425. protected _onPointerDown(coordinates: Vector2): boolean;
  426. }
  427. }
  428. declare module BABYLON.GUI {
  429. class TextBlock extends Control {
  430. name: string;
  431. private _text;
  432. private _textY;
  433. private _textWrapping;
  434. private _textHorizontalAlignment;
  435. private _textVerticalAlignment;
  436. private _lines;
  437. private _totalHeight;
  438. textWrapping: boolean;
  439. text: string;
  440. textHorizontalAlignment: number;
  441. textVerticalAlignment: number;
  442. constructor(name?: string, text?: string);
  443. protected _getTypeName(): string;
  444. private _drawText(text, textWidth, y, context);
  445. _draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  446. protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  447. protected _parseLine(line: string, context: CanvasRenderingContext2D): object;
  448. protected _parseLineWithTextWrapping(line: string, context: CanvasRenderingContext2D): object;
  449. protected _renderLines(context: CanvasRenderingContext2D): void;
  450. }
  451. }
  452. declare var DOMImage: new (width?: number, height?: number) => HTMLImageElement;
  453. declare module BABYLON.GUI {
  454. class Image extends Control {
  455. name: string;
  456. private _domImage;
  457. private _imageWidth;
  458. private _imageHeight;
  459. private _loaded;
  460. private _stretch;
  461. private _source;
  462. private _autoScale;
  463. private _sourceLeft;
  464. private _sourceTop;
  465. private _sourceWidth;
  466. private _sourceHeight;
  467. sourceLeft: number;
  468. sourceTop: number;
  469. sourceWidth: number;
  470. sourceHeight: number;
  471. autoScale: boolean;
  472. stretch: number;
  473. domImage: HTMLImageElement;
  474. private _onImageLoaded();
  475. source: string;
  476. constructor(name?: string, url?: string);
  477. protected _getTypeName(): string;
  478. synchronizeSizeWithContent(): void;
  479. _draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  480. private static _STRETCH_NONE;
  481. private static _STRETCH_FILL;
  482. private static _STRETCH_UNIFORM;
  483. private static _STRETCH_EXTEND;
  484. static readonly STRETCH_NONE: number;
  485. static readonly STRETCH_FILL: number;
  486. static readonly STRETCH_UNIFORM: number;
  487. static readonly STRETCH_EXTEND: number;
  488. }
  489. }
  490. declare module BABYLON.GUI {
  491. class Button extends Rectangle {
  492. name: string;
  493. pointerEnterAnimation: () => void;
  494. pointerOutAnimation: () => void;
  495. pointerDownAnimation: () => void;
  496. pointerUpAnimation: () => void;
  497. constructor(name?: string);
  498. protected _getTypeName(): string;
  499. _processPicking(x: number, y: number, type: number): boolean;
  500. protected _onPointerEnter(): boolean;
  501. protected _onPointerOut(): void;
  502. protected _onPointerDown(coordinates: Vector2): boolean;
  503. protected _onPointerUp(coordinates: Vector2): void;
  504. static CreateImageButton(name: string, text: string, imageUrl: string): Button;
  505. static CreateImageOnlyButton(name: string, imageUrl: string): Button;
  506. static CreateSimpleButton(name: string, text: string): Button;
  507. }
  508. }
  509. declare var DOMImage: new (width?: number, height?: number) => HTMLImageElement;
  510. declare module BABYLON.GUI {
  511. class ColorPicker extends Control {
  512. name: string;
  513. private _colorWheelCanvas;
  514. private _value;
  515. private _tmpColor;
  516. private _pointerStartedOnSquare;
  517. private _pointerStartedOnWheel;
  518. private _squareLeft;
  519. private _squareTop;
  520. private _squareSize;
  521. private _h;
  522. private _s;
  523. private _v;
  524. onValueChangedObservable: Observable<Color3>;
  525. value: Color3;
  526. width: string | number;
  527. height: string | number;
  528. size: string | number;
  529. constructor(name?: string);
  530. protected _getTypeName(): string;
  531. private _updateSquareProps();
  532. private _drawGradientSquare(hueValue, left, top, width, height, context);
  533. private _drawCircle(centerX, centerY, radius, context);
  534. private _createColorWheelCanvas(radius, thickness);
  535. private _RGBtoHSV(color, result);
  536. private _HSVtoRGB(hue, saturation, value, result);
  537. _draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  538. private _pointerIsDown;
  539. private _updateValueFromPointer(x, y);
  540. private _isPointOnSquare(coordinates);
  541. private _isPointOnWheel(coordinates);
  542. protected _onPointerDown(coordinates: Vector2): boolean;
  543. protected _onPointerMove(coordinates: Vector2): void;
  544. protected _onPointerUp(coordinates: Vector2): void;
  545. }
  546. }