babylon.gui.d.ts 17 KB

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