babylon.gui.d.ts 21 KB

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