babylon.gui.d.ts 22 KB

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