babylon.gui.d.ts 89 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430
  1. declare module BABYLON.GUI {
  2. /**
  3. * Define a style used by control to automatically setup properties based on a template.
  4. * Only support font related properties so far
  5. */
  6. class Style implements BABYLON.IDisposable {
  7. private _fontFamily;
  8. private _fontStyle;
  9. private _fontWeight;
  10. /** @hidden */
  11. _host: AdvancedDynamicTexture;
  12. /** @hidden */
  13. _fontSize: ValueAndUnit;
  14. /**
  15. * Observable raised when the style values are changed
  16. */
  17. onChangedObservable: Observable<Style>;
  18. /**
  19. * Creates a new style object
  20. * @param host defines the AdvancedDynamicTexture which hosts this style
  21. */
  22. constructor(host: AdvancedDynamicTexture);
  23. /**
  24. * Gets or sets the font size
  25. */
  26. fontSize: string | number;
  27. /**
  28. * Gets or sets the font family
  29. */
  30. fontFamily: string;
  31. /**
  32. * Gets or sets the font style
  33. */
  34. fontStyle: string;
  35. /** Gets or sets font weight */
  36. fontWeight: string;
  37. /** Dispose all associated resources */
  38. dispose(): void;
  39. }
  40. }
  41. declare module BABYLON.GUI {
  42. /**
  43. * Class used to specific a value and its associated unit
  44. */
  45. class ValueAndUnit {
  46. /** defines the unit to store */
  47. unit: number;
  48. /** defines a boolean indicating if the value can be negative */
  49. negativeValueAllowed: boolean;
  50. private _value;
  51. /**
  52. * Gets or sets a value indicating that this value will not scale accordingly with adaptive scaling property
  53. * @see http://doc.babylonjs.com/how_to/gui#adaptive-scaling
  54. */
  55. ignoreAdaptiveScaling: boolean;
  56. /**
  57. * Creates a new ValueAndUnit
  58. * @param value defines the value to store
  59. * @param unit defines the unit to store
  60. * @param negativeValueAllowed defines a boolean indicating if the value can be negative
  61. */
  62. constructor(value: number,
  63. /** defines the unit to store */
  64. unit?: number,
  65. /** defines a boolean indicating if the value can be negative */
  66. negativeValueAllowed?: boolean);
  67. /** Gets a boolean indicating if the value is a percentage */
  68. readonly isPercentage: boolean;
  69. /** Gets a boolean indicating if the value is store as pixel */
  70. readonly isPixel: boolean;
  71. /** Gets direct internal value */
  72. readonly internalValue: number;
  73. /**
  74. * Gets value as pixel
  75. * @param host defines the root host
  76. * @param refValue defines the reference value for percentages
  77. * @returns the value as pixel
  78. */
  79. getValueInPixel(host: AdvancedDynamicTexture, refValue: number): number;
  80. /**
  81. * Gets the value accordingly to its unit
  82. * @param host defines the root host
  83. * @returns the value
  84. */
  85. getValue(host: AdvancedDynamicTexture): number;
  86. /**
  87. * Gets a string representation of the value
  88. * @param host defines the root host
  89. * @returns a string
  90. */
  91. toString(host: AdvancedDynamicTexture): string;
  92. /**
  93. * Store a value parsed from a string
  94. * @param source defines the source string
  95. * @returns true if the value was successfully parsed
  96. */
  97. fromString(source: string | number): boolean;
  98. private static _Regex;
  99. private static _UNITMODE_PERCENTAGE;
  100. private static _UNITMODE_PIXEL;
  101. /** UNITMODE_PERCENTAGE */
  102. static readonly UNITMODE_PERCENTAGE: number;
  103. /** UNITMODE_PIXEL */
  104. static readonly UNITMODE_PIXEL: number;
  105. }
  106. }
  107. /**
  108. * This module hosts all controls for 2D and 3D GUIs
  109. * @see http://doc.babylonjs.com/how_to/gui
  110. */
  111. declare module BABYLON.GUI {
  112. /**
  113. * Interface used to define a control that can receive focus
  114. */
  115. interface IFocusableControl {
  116. /**
  117. * Function called when the control receives the focus
  118. */
  119. onFocus(): void;
  120. /**
  121. * Function called when the control loses the focus
  122. */
  123. onBlur(): void;
  124. /**
  125. * Function called to let the control handle keyboard events
  126. * @param evt defines the current keyboard event
  127. */
  128. processKeyboard(evt: KeyboardEvent): void;
  129. }
  130. /**
  131. * Class used to create texture to support 2D GUI elements
  132. * @see http://doc.babylonjs.com/how_to/gui
  133. */
  134. class AdvancedDynamicTexture extends DynamicTexture {
  135. private _isDirty;
  136. private _renderObserver;
  137. private _resizeObserver;
  138. private _preKeyboardObserver;
  139. private _pointerMoveObserver;
  140. private _pointerObserver;
  141. private _canvasPointerOutObserver;
  142. private _background;
  143. /** @hidden */
  144. _rootContainer: Container;
  145. /** @hidden */
  146. _lastPickedControl: Control;
  147. /** @hidden */
  148. _lastControlOver: {
  149. [pointerId: number]: Control;
  150. };
  151. /** @hidden */
  152. _lastControlDown: {
  153. [pointerId: number]: Control;
  154. };
  155. /** @hidden */
  156. _capturingControl: {
  157. [pointerId: number]: Control;
  158. };
  159. /** @hidden */
  160. _shouldBlockPointer: boolean;
  161. /** @hidden */
  162. _layerToDispose: Nullable<Layer>;
  163. /** @hidden */
  164. _linkedControls: Control[];
  165. private _isFullscreen;
  166. private _fullscreenViewport;
  167. private _idealWidth;
  168. private _idealHeight;
  169. private _useSmallestIdeal;
  170. private _renderAtIdealSize;
  171. private _focusedControl;
  172. private _blockNextFocusCheck;
  173. private _renderScale;
  174. /**
  175. * Gets or sets a boolean defining if alpha is stored as premultiplied
  176. */
  177. premulAlpha: boolean;
  178. /**
  179. * Gets or sets a number used to scale rendering size (2 means that the texture will be twice bigger).
  180. * Useful when you want more antialiasing
  181. */
  182. renderScale: number;
  183. /** Gets or sets the background color */
  184. background: string;
  185. /**
  186. * Gets or sets the ideal width used to design controls.
  187. * The GUI will then rescale everything accordingly
  188. * @see http://doc.babylonjs.com/how_to/gui#adaptive-scaling
  189. */
  190. idealWidth: number;
  191. /**
  192. * Gets or sets the ideal height used to design controls.
  193. * The GUI will then rescale everything accordingly
  194. * @see http://doc.babylonjs.com/how_to/gui#adaptive-scaling
  195. */
  196. idealHeight: number;
  197. /**
  198. * Gets or sets a boolean indicating if the smallest ideal value must be used if idealWidth and idealHeight are both set
  199. * @see http://doc.babylonjs.com/how_to/gui#adaptive-scaling
  200. */
  201. useSmallestIdeal: boolean;
  202. /**
  203. * Gets or sets a boolean indicating if adaptive scaling must be used
  204. * @see http://doc.babylonjs.com/how_to/gui#adaptive-scaling
  205. */
  206. renderAtIdealSize: boolean;
  207. /**
  208. * Gets the underlying layer used to render the texture when in fullscreen mode
  209. */
  210. readonly layer: Nullable<Layer>;
  211. /**
  212. * Gets the root container control
  213. */
  214. readonly rootContainer: Container;
  215. /**
  216. * Gets or sets the current focused control
  217. */
  218. focusedControl: Nullable<IFocusableControl>;
  219. /**
  220. * Gets or sets a boolean indicating if the texture must be rendered in background or foreground when in fullscreen mode
  221. */
  222. isForeground: boolean;
  223. /**
  224. * Creates a new AdvancedDynamicTexture
  225. * @param name defines the name of the texture
  226. * @param width defines the width of the texture
  227. * @param height defines the height of the texture
  228. * @param scene defines the hosting scene
  229. * @param generateMipMaps defines a boolean indicating if mipmaps must be generated (false by default)
  230. * @param samplingMode defines the texture sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  231. */
  232. constructor(name: string, width: number | undefined, height: number | undefined, scene: Nullable<Scene>, generateMipMaps?: boolean, samplingMode?: number);
  233. /**
  234. * Function used to execute a function on all controls
  235. * @param func defines the function to execute
  236. * @param container defines the container where controls belong. If null the root container will be used
  237. */
  238. executeOnAllControls(func: (control: Control) => void, container?: Container): void;
  239. /**
  240. * Marks the texture as dirty forcing a complete update
  241. */
  242. markAsDirty(): void;
  243. /**
  244. * Helper function used to create a new style
  245. * @returns a new style
  246. * @see http://doc.babylonjs.com/how_to/gui#styles
  247. */
  248. createStyle(): Style;
  249. /**
  250. * Adds a new control to the root container
  251. * @param control defines the control to add
  252. * @returns the current texture
  253. */
  254. addControl(control: Control): AdvancedDynamicTexture;
  255. /**
  256. * Removes a control from the root container
  257. * @param control defines the control to remove
  258. * @returns the current texture
  259. */
  260. removeControl(control: Control): AdvancedDynamicTexture;
  261. /**
  262. * Release all resources
  263. */
  264. dispose(): void;
  265. private _onResize();
  266. /** @hidden */
  267. _getGlobalViewport(scene: Scene): Viewport;
  268. /**
  269. * Get screen coordinates for a vector3
  270. * @param position defines the position to project
  271. * @param worldMatrix defines the world matrix to use
  272. * @returns the projected position
  273. */
  274. getProjectedPosition(position: Vector3, worldMatrix: Matrix): Vector2;
  275. private _checkUpdate(camera);
  276. private _render();
  277. private _doPicking(x, y, type, pointerId, buttonIndex);
  278. /** @hidden */
  279. _cleanControlAfterRemovalFromList(list: {
  280. [pointerId: number]: Control;
  281. }, control: Control): void;
  282. /** @hidden */
  283. _cleanControlAfterRemoval(control: Control): void;
  284. /** Attach to all scene events required to support pointer events */
  285. attach(): void;
  286. /**
  287. * Connect the texture to a hosting mesh to enable interactions
  288. * @param mesh defines the mesh to attach to
  289. * @param supportPointerMove defines a boolean indicating if pointer move events must be catched as well
  290. */
  291. attachToMesh(mesh: AbstractMesh, supportPointerMove?: boolean): void;
  292. /**
  293. * Move the focus to a specific control
  294. * @param control defines the control which will receive the focus
  295. */
  296. moveFocusToControl(control: IFocusableControl): void;
  297. private _manageFocus();
  298. private _attachToOnPointerOut(scene);
  299. /**
  300. * Creates a new AdvancedDynamicTexture in projected mode (ie. attached to a mesh)
  301. * @param mesh defines the mesh which will receive the texture
  302. * @param width defines the texture width (1024 by default)
  303. * @param height defines the texture height (1024 by default)
  304. * @param supportPointerMove defines a boolean indicating if the texture must capture move events (true by default)
  305. * @returns a new AdvancedDynamicTexture
  306. */
  307. static CreateForMesh(mesh: AbstractMesh, width?: number, height?: number, supportPointerMove?: boolean): AdvancedDynamicTexture;
  308. /**
  309. * Creates a new AdvancedDynamicTexture in fullscreen mode.
  310. * In this mode the texture will rely on a layer for its rendering.
  311. * This allows it to be treated like any other layer.
  312. * As such, if you have a multi camera setup, you can set the layerMask on the GUI as well.
  313. * LayerMask is set through advancedTexture.layer.layerMask
  314. * @param name defines name for the texture
  315. * @param foreground defines a boolean indicating if the texture must be rendered in foreground (default is true)
  316. * @param scene defines the hsoting scene
  317. * @param sampling defines the texture sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  318. * @returns a new AdvancedDynamicTexture
  319. */
  320. static CreateFullscreenUI(name: string, foreground?: boolean, scene?: Nullable<Scene>, sampling?: number): AdvancedDynamicTexture;
  321. }
  322. }
  323. declare module BABYLON.GUI {
  324. /**
  325. * Class used to store 2D control sizes
  326. */
  327. class Measure {
  328. /** defines left coordinate */
  329. left: number;
  330. /** defines top coordinate */
  331. top: number;
  332. /** defines width dimension */
  333. width: number;
  334. /** defines height dimension */
  335. height: number;
  336. /**
  337. * Creates a new measure
  338. * @param left defines left coordinate
  339. * @param top defines top coordinate
  340. * @param width defines width dimension
  341. * @param height defines height dimension
  342. */
  343. constructor(
  344. /** defines left coordinate */
  345. left: number,
  346. /** defines top coordinate */
  347. top: number,
  348. /** defines width dimension */
  349. width: number,
  350. /** defines height dimension */
  351. height: number);
  352. /**
  353. * Copy from another measure
  354. * @param other defines the other measure to copy from
  355. */
  356. copyFrom(other: Measure): void;
  357. /**
  358. * Check equality between this measure and another one
  359. * @param other defines the other measures
  360. * @returns true if both measures are equals
  361. */
  362. isEqualsTo(other: Measure): boolean;
  363. /**
  364. * Creates an empty measure
  365. * @returns a new measure
  366. */
  367. static Empty(): Measure;
  368. }
  369. }
  370. declare module BABYLON.GUI {
  371. /**
  372. * Class used to transport Vector2 information for pointer events
  373. */
  374. class Vector2WithInfo extends Vector2 {
  375. /** defines the current mouse button index */
  376. buttonIndex: number;
  377. /**
  378. * Creates a new Vector2WithInfo
  379. * @param source defines the vector2 data to transport
  380. * @param buttonIndex defines the current mouse button index
  381. */
  382. constructor(source: Vector2,
  383. /** defines the current mouse button index */
  384. buttonIndex?: number);
  385. }
  386. /** Class used to provide 2D matrix features */
  387. class Matrix2D {
  388. /** Gets the internal array of 6 floats used to store matrix data */
  389. m: Float32Array;
  390. /**
  391. * Creates a new matrix
  392. * @param m00 defines value for (0, 0)
  393. * @param m01 defines value for (0, 1)
  394. * @param m10 defines value for (1, 0)
  395. * @param m11 defines value for (1, 1)
  396. * @param m20 defines value for (2, 0)
  397. * @param m21 defines value for (2, 1)
  398. */
  399. constructor(m00: number, m01: number, m10: number, m11: number, m20: number, m21: number);
  400. /**
  401. * Fills the matrix from direct values
  402. * @param m00 defines value for (0, 0)
  403. * @param m01 defines value for (0, 1)
  404. * @param m10 defines value for (1, 0)
  405. * @param m11 defines value for (1, 1)
  406. * @param m20 defines value for (2, 0)
  407. * @param m21 defines value for (2, 1)
  408. * @returns the current modified matrix
  409. */
  410. fromValues(m00: number, m01: number, m10: number, m11: number, m20: number, m21: number): Matrix2D;
  411. /**
  412. * Gets matrix determinant
  413. * @returns the determinant
  414. */
  415. determinant(): number;
  416. /**
  417. * Inverses the matrix and stores it in a target matrix
  418. * @param result defines the target matrix
  419. * @returns the current matrix
  420. */
  421. invertToRef(result: Matrix2D): Matrix2D;
  422. /**
  423. * Multiplies the current matrix with another one
  424. * @param other defines the second operand
  425. * @param result defines the target matrix
  426. * @returns the current matrix
  427. */
  428. multiplyToRef(other: Matrix2D, result: Matrix2D): Matrix2D;
  429. /**
  430. * Applies the current matrix to a set of 2 floats and stores the result in a vector2
  431. * @param x defines the x coordinate to transform
  432. * @param y defines the x coordinate to transform
  433. * @param result defines the target vector2
  434. * @returns the current matrix
  435. */
  436. transformCoordinates(x: number, y: number, result: Vector2): Matrix2D;
  437. /**
  438. * Creates an identity matrix
  439. * @returns a new matrix
  440. */
  441. static Identity(): Matrix2D;
  442. /**
  443. * Creates a translation matrix and stores it in a target matrix
  444. * @param x defines the x coordinate of the translation
  445. * @param y defines the y coordinate of the translation
  446. * @param result defines the target matrix
  447. */
  448. static TranslationToRef(x: number, y: number, result: Matrix2D): void;
  449. /**
  450. * Creates a scaling matrix and stores it in a target matrix
  451. * @param x defines the x coordinate of the scaling
  452. * @param y defines the y coordinate of the scaling
  453. * @param result defines the target matrix
  454. */
  455. static ScalingToRef(x: number, y: number, result: Matrix2D): void;
  456. /**
  457. * Creates a rotation matrix and stores it in a target matrix
  458. * @param angle defines the rotation angle
  459. * @param result defines the target matrix
  460. */
  461. static RotationToRef(angle: number, result: Matrix2D): void;
  462. private static _TempPreTranslationMatrix;
  463. private static _TempPostTranslationMatrix;
  464. private static _TempRotationMatrix;
  465. private static _TempScalingMatrix;
  466. private static _TempCompose0;
  467. private static _TempCompose1;
  468. private static _TempCompose2;
  469. /**
  470. * Composes a matrix from translation, rotation, scaling and parent matrix and stores it in a target matrix
  471. * @param tx defines the x coordinate of the translation
  472. * @param ty defines the y coordinate of the translation
  473. * @param angle defines the rotation angle
  474. * @param scaleX defines the x coordinate of the scaling
  475. * @param scaleY defines the y coordinate of the scaling
  476. * @param parentMatrix defines the parent matrix to multiply by (can be null)
  477. * @param result defines the target matrix
  478. */
  479. static ComposeToRef(tx: number, ty: number, angle: number, scaleX: number, scaleY: number, parentMatrix: Nullable<Matrix2D>, result: Matrix2D): void;
  480. }
  481. }
  482. declare module BABYLON.GUI {
  483. /**
  484. * Class used to store a point for a MultiLine object.
  485. * The point can be pure 2D coordinates, a mesh or a control
  486. */
  487. class MultiLinePoint {
  488. private _multiLine;
  489. private _x;
  490. private _y;
  491. private _control;
  492. private _mesh;
  493. private _controlObserver;
  494. private _meshObserver;
  495. /** @hidden */
  496. _point: Vector2;
  497. /**
  498. * Creates a new MultiLinePoint
  499. * @param multiLine defines the source MultiLine object
  500. */
  501. constructor(multiLine: MultiLine);
  502. /** Gets or sets x coordinate */
  503. x: string | number;
  504. /** Gets or sets y coordinate */
  505. y: string | number;
  506. /** Gets or sets the control associated with this point */
  507. control: Nullable<Control>;
  508. /** Gets or sets the mesh associated with this point */
  509. mesh: Nullable<AbstractMesh>;
  510. /**
  511. * Gets a translation vector
  512. * @returns the translation vector
  513. */
  514. translate(): Vector2;
  515. private _translatePoint();
  516. /** Release associated resources */
  517. dispose(): void;
  518. }
  519. }
  520. declare module BABYLON.GUI {
  521. /**
  522. * Root class used for all 2D controls
  523. * @see http://doc.babylonjs.com/how_to/gui#controls
  524. */
  525. class Control {
  526. /** defines the name of the control */
  527. name: string | undefined;
  528. private _alpha;
  529. private _alphaSet;
  530. private _zIndex;
  531. /** @hidden */
  532. _root: Nullable<Container>;
  533. /** @hidden */
  534. _host: AdvancedDynamicTexture;
  535. /** Gets or sets the control parent */
  536. parent: Nullable<Container>;
  537. /** @hidden */
  538. _currentMeasure: Measure;
  539. private _fontFamily;
  540. private _fontStyle;
  541. private _fontWeight;
  542. private _fontSize;
  543. private _font;
  544. /** @hidden */
  545. _width: ValueAndUnit;
  546. /** @hidden */
  547. _height: ValueAndUnit;
  548. /** @hidden */
  549. protected _fontOffset: {
  550. ascent: number;
  551. height: number;
  552. descent: number;
  553. };
  554. private _color;
  555. private _style;
  556. private _styleObserver;
  557. /** @hidden */
  558. protected _horizontalAlignment: number;
  559. /** @hidden */
  560. protected _verticalAlignment: number;
  561. private _isDirty;
  562. /** @hidden */
  563. _tempParentMeasure: Measure;
  564. /** @hidden */
  565. protected _cachedParentMeasure: Measure;
  566. private _paddingLeft;
  567. private _paddingRight;
  568. private _paddingTop;
  569. private _paddingBottom;
  570. /** @hidden */
  571. _left: ValueAndUnit;
  572. /** @hidden */
  573. _top: ValueAndUnit;
  574. private _scaleX;
  575. private _scaleY;
  576. private _rotation;
  577. private _transformCenterX;
  578. private _transformCenterY;
  579. private _transformMatrix;
  580. /** @hidden */
  581. protected _invertTransformMatrix: Matrix2D;
  582. /** @hidden */
  583. protected _transformedPosition: Vector2;
  584. private _onlyMeasureMode;
  585. private _isMatrixDirty;
  586. private _cachedOffsetX;
  587. private _cachedOffsetY;
  588. private _isVisible;
  589. /** @hidden */
  590. _linkedMesh: Nullable<AbstractMesh>;
  591. private _fontSet;
  592. private _dummyVector2;
  593. private _downCount;
  594. private _enterCount;
  595. private _doNotRender;
  596. private _downPointerIds;
  597. /** Gets or sets a boolean indicating if the control can be hit with pointer events */
  598. isHitTestVisible: boolean;
  599. /** Gets or sets a boolean indicating if the control can block pointer events */
  600. isPointerBlocker: boolean;
  601. /** Gets or sets a boolean indicating if the control can be focusable */
  602. isFocusInvisible: boolean;
  603. /** Gets or sets a value indicating the offset to apply on X axis to render the shadow */
  604. shadowOffsetX: number;
  605. /** Gets or sets a value indicating the offset to apply on Y axis to render the shadow */
  606. shadowOffsetY: number;
  607. /** Gets or sets a value indicating the amount of blur to use to render the shadow */
  608. shadowBlur: number;
  609. /** Gets or sets a value indicating the color of the shadow (black by default ie. "#000") */
  610. shadowColor: string;
  611. /** @hidden */
  612. protected _linkOffsetX: ValueAndUnit;
  613. /** @hidden */
  614. protected _linkOffsetY: ValueAndUnit;
  615. /** Gets the control type name */
  616. readonly typeName: string;
  617. /**
  618. * An event triggered when the pointer move over the control.
  619. */
  620. onPointerMoveObservable: Observable<Vector2>;
  621. /**
  622. * An event triggered when the pointer move out of the control.
  623. */
  624. onPointerOutObservable: Observable<Control>;
  625. /**
  626. * An event triggered when the pointer taps the control
  627. */
  628. onPointerDownObservable: Observable<Vector2WithInfo>;
  629. /**
  630. * An event triggered when pointer up
  631. */
  632. onPointerUpObservable: Observable<Vector2WithInfo>;
  633. /**
  634. * An event triggered when a control is clicked on
  635. */
  636. onPointerClickObservable: Observable<Vector2WithInfo>;
  637. /**
  638. * An event triggered when pointer enters the control
  639. */
  640. onPointerEnterObservable: Observable<Control>;
  641. /**
  642. * An event triggered when the control is marked as dirty
  643. */
  644. onDirtyObservable: Observable<Control>;
  645. /**
  646. * An event triggered after the control is drawn
  647. */
  648. onAfterDrawObservable: Observable<Control>;
  649. /** Gets or set information about font offsets (used to render and align text) */
  650. fontOffset: {
  651. ascent: number;
  652. height: number;
  653. descent: number;
  654. };
  655. /** Gets or sets alpha value for the control (1 means opaque and 0 means entirely transparent) */
  656. alpha: number;
  657. /** Gets or sets a value indicating the scale factor on X axis (1 by default)
  658. * @see http://doc.babylonjs.com/how_to/gui#rotation-and-scaling
  659. */
  660. scaleX: number;
  661. /** Gets or sets a value indicating the scale factor on Y axis (1 by default)
  662. * @see http://doc.babylonjs.com/how_to/gui#rotation-and-scaling
  663. */
  664. scaleY: number;
  665. /** Gets or sets the rotation angle (0 by default)
  666. * @see http://doc.babylonjs.com/how_to/gui#rotation-and-scaling
  667. */
  668. rotation: number;
  669. /** Gets or sets the transformation center on Y axis (0 by default)
  670. * @see http://doc.babylonjs.com/how_to/gui#rotation-and-scaling
  671. */
  672. transformCenterY: number;
  673. /** Gets or sets the transformation center on X axis (0 by default)
  674. * @see http://doc.babylonjs.com/how_to/gui#rotation-and-scaling
  675. */
  676. transformCenterX: number;
  677. /**
  678. * Gets or sets the horizontal alignment
  679. * @see http://doc.babylonjs.com/how_to/gui#alignments
  680. */
  681. horizontalAlignment: number;
  682. /**
  683. * Gets or sets the vertical alignment
  684. * @see http://doc.babylonjs.com/how_to/gui#alignments
  685. */
  686. verticalAlignment: number;
  687. /**
  688. * Gets or sets control width
  689. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  690. */
  691. width: string | number;
  692. /**
  693. * Gets control width in pixel
  694. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  695. */
  696. readonly widthInPixels: number;
  697. /**
  698. * Gets or sets control height
  699. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  700. */
  701. height: string | number;
  702. /**
  703. * Gets control height in pixel
  704. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  705. */
  706. readonly heightInPixels: number;
  707. /** Gets or set font family */
  708. fontFamily: string;
  709. /** Gets or sets font style */
  710. fontStyle: string;
  711. /** Gets or sets font weight */
  712. fontWeight: string;
  713. /**
  714. * Gets or sets style
  715. * @see http://doc.babylonjs.com/how_to/gui#styles
  716. */
  717. style: BABYLON.Nullable<Style>;
  718. /** @hidden */
  719. readonly _isFontSizeInPercentage: boolean;
  720. /** Gets font size in pixels */
  721. readonly fontSizeInPixels: number;
  722. /** Gets or sets font size */
  723. fontSize: string | number;
  724. /** Gets or sets foreground color */
  725. color: string;
  726. /** Gets or sets z index which is used to reorder controls on the z axis */
  727. zIndex: number;
  728. /** Gets or sets a boolean indicating if the control can be rendered */
  729. notRenderable: boolean;
  730. /** Gets or sets a boolean indicating if the control is visible */
  731. isVisible: boolean;
  732. /** Gets a boolean indicating that the control needs to update its rendering */
  733. readonly isDirty: boolean;
  734. /**
  735. * Gets or sets a value indicating the padding to use on the left of the control
  736. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  737. */
  738. paddingLeft: string | number;
  739. /**
  740. * Gets a value indicating the padding in pixels to use on the left of the control
  741. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  742. */
  743. readonly paddingLeftInPixels: number;
  744. /**
  745. * Gets or sets a value indicating the padding to use on the right of the control
  746. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  747. */
  748. paddingRight: string | number;
  749. /**
  750. * Gets a value indicating the padding in pixels to use on the right of the control
  751. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  752. */
  753. readonly paddingRightInPixels: number;
  754. /**
  755. * Gets or sets a value indicating the padding to use on the top of the control
  756. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  757. */
  758. paddingTop: string | number;
  759. /**
  760. * Gets a value indicating the padding in pixels to use on the top of the control
  761. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  762. */
  763. readonly paddingTopInPixels: number;
  764. /**
  765. * Gets or sets a value indicating the padding to use on the bottom of the control
  766. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  767. */
  768. paddingBottom: string | number;
  769. /**
  770. * Gets a value indicating the padding in pixels to use on the bottom of the control
  771. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  772. */
  773. readonly paddingBottomInPixels: number;
  774. /**
  775. * Gets or sets a value indicating the left coordinate of the control
  776. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  777. */
  778. left: string | number;
  779. /**
  780. * Gets a value indicating the left coordinate in pixels of the control
  781. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  782. */
  783. readonly leftInPixels: number;
  784. /**
  785. * Gets or sets a value indicating the top coordinate of the control
  786. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  787. */
  788. top: string | number;
  789. /**
  790. * Gets a value indicating the top coordinate in pixels of the control
  791. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  792. */
  793. readonly topInPixels: number;
  794. /**
  795. * Gets or sets a value indicating the offset on X axis to the linked mesh
  796. * @see http://doc.babylonjs.com/how_to/gui#tracking-positions
  797. */
  798. linkOffsetX: string | number;
  799. /**
  800. * Gets a value indicating the offset in pixels on X axis to the linked mesh
  801. * @see http://doc.babylonjs.com/how_to/gui#tracking-positions
  802. */
  803. readonly linkOffsetXInPixels: number;
  804. /**
  805. * Gets or sets a value indicating the offset on Y axis to the linked mesh
  806. * @see http://doc.babylonjs.com/how_to/gui#tracking-positions
  807. */
  808. linkOffsetY: string | number;
  809. /**
  810. * Gets a value indicating the offset in pixels on Y axis to the linked mesh
  811. * @see http://doc.babylonjs.com/how_to/gui#tracking-positions
  812. */
  813. readonly linkOffsetYInPixels: number;
  814. /** Gets the center coordinate on X axis */
  815. readonly centerX: number;
  816. /** Gets the center coordinate on Y axis */
  817. readonly centerY: number;
  818. /**
  819. * Creates a new control
  820. * @param name defines the name of the control
  821. */
  822. constructor(
  823. /** defines the name of the control */
  824. name?: string | undefined);
  825. /** @hidden */
  826. protected _getTypeName(): string;
  827. /** @hidden */
  828. _resetFontCache(): void;
  829. /**
  830. * Gets coordinates in local control space
  831. * @param globalCoordinates defines the coordinates to transform
  832. * @returns the new coordinates in local space
  833. */
  834. getLocalCoordinates(globalCoordinates: Vector2): Vector2;
  835. /**
  836. * Gets coordinates in local control space
  837. * @param globalCoordinates defines the coordinates to transform
  838. * @param result defines the target vector2 where to store the result
  839. * @returns the current control
  840. */
  841. getLocalCoordinatesToRef(globalCoordinates: Vector2, result: Vector2): Control;
  842. /**
  843. * Gets coordinates in parent local control space
  844. * @param globalCoordinates defines the coordinates to transform
  845. * @returns the new coordinates in parent local space
  846. */
  847. getParentLocalCoordinates(globalCoordinates: Vector2): Vector2;
  848. /**
  849. * Move the current control to a vector3 position projected onto the screen.
  850. * @param position defines the target position
  851. * @param scene defines the hosting scene
  852. */
  853. moveToVector3(position: Vector3, scene: Scene): void;
  854. /**
  855. * Link current control with a target mesh
  856. * @param mesh defines the mesh to link with
  857. * @see http://doc.babylonjs.com/how_to/gui#tracking-positions
  858. */
  859. linkWithMesh(mesh: Nullable<AbstractMesh>): void;
  860. /** @hidden */
  861. _moveToProjectedPosition(projectedPosition: Vector3): void;
  862. /** @hidden */
  863. _markMatrixAsDirty(): void;
  864. /** @hidden */
  865. _markAsDirty(): void;
  866. /** @hidden */
  867. _markAllAsDirty(): void;
  868. /** @hidden */
  869. _link(root: Nullable<Container>, host: AdvancedDynamicTexture): void;
  870. /** @hidden */
  871. protected _transform(context: CanvasRenderingContext2D): void;
  872. /** @hidden */
  873. protected _applyStates(context: CanvasRenderingContext2D): void;
  874. /** @hidden */
  875. protected _processMeasures(parentMeasure: Measure, context: CanvasRenderingContext2D): boolean;
  876. /** @hidden */
  877. protected _clip(context: CanvasRenderingContext2D): void;
  878. /** @hidden */
  879. _measure(): void;
  880. /** @hidden */
  881. protected _computeAlignment(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  882. /** @hidden */
  883. protected _preMeasure(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  884. /** @hidden */
  885. protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  886. /** @hidden */
  887. _draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  888. /**
  889. * Tests if a given coordinates belong to the current control
  890. * @param x defines x coordinate to test
  891. * @param y defines y coordinate to test
  892. * @returns true if the coordinates are inside the control
  893. */
  894. contains(x: number, y: number): boolean;
  895. /** @hidden */
  896. _processPicking(x: number, y: number, type: number, pointerId: number, buttonIndex: number): boolean;
  897. /** @hidden */
  898. _onPointerMove(target: Control, coordinates: Vector2): void;
  899. /** @hidden */
  900. _onPointerEnter(target: Control): boolean;
  901. /** @hidden */
  902. _onPointerOut(target: Control): void;
  903. /** @hidden */
  904. _onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
  905. /** @hidden */
  906. _onPointerUp(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean): void;
  907. /** @hidden */
  908. _forcePointerUp(pointerId?: Nullable<number>): void;
  909. /** @hidden */
  910. _processObservables(type: number, x: number, y: number, pointerId: number, buttonIndex: number): boolean;
  911. private _prepareFont();
  912. /** Releases associated resources */
  913. dispose(): void;
  914. private static _HORIZONTAL_ALIGNMENT_LEFT;
  915. private static _HORIZONTAL_ALIGNMENT_RIGHT;
  916. private static _HORIZONTAL_ALIGNMENT_CENTER;
  917. private static _VERTICAL_ALIGNMENT_TOP;
  918. private static _VERTICAL_ALIGNMENT_BOTTOM;
  919. private static _VERTICAL_ALIGNMENT_CENTER;
  920. /** HORIZONTAL_ALIGNMENT_LEFT */
  921. static readonly HORIZONTAL_ALIGNMENT_LEFT: number;
  922. /** HORIZONTAL_ALIGNMENT_RIGHT */
  923. static readonly HORIZONTAL_ALIGNMENT_RIGHT: number;
  924. /** HORIZONTAL_ALIGNMENT_CENTER */
  925. static readonly HORIZONTAL_ALIGNMENT_CENTER: number;
  926. /** VERTICAL_ALIGNMENT_TOP */
  927. static readonly VERTICAL_ALIGNMENT_TOP: number;
  928. /** VERTICAL_ALIGNMENT_BOTTOM */
  929. static readonly VERTICAL_ALIGNMENT_BOTTOM: number;
  930. /** VERTICAL_ALIGNMENT_CENTER */
  931. static readonly VERTICAL_ALIGNMENT_CENTER: number;
  932. private static _FontHeightSizes;
  933. /** @hidden */
  934. static _GetFontOffset(font: string): {
  935. ascent: number;
  936. height: number;
  937. descent: number;
  938. };
  939. /**
  940. * Creates a stack panel that can be used to render headers
  941. * @param control defines the control to associate with the header
  942. * @param text defines the text of the header
  943. * @param size defines the size of the header
  944. * @param options defines options used to configure the header
  945. * @returns a new StackPanel
  946. */
  947. static AddHeader(control: Control, text: string, size: string | number, options: {
  948. isHorizontal: boolean;
  949. controlFirst: boolean;
  950. }): StackPanel;
  951. /** @hidden */
  952. protected static drawEllipse(x: number, y: number, width: number, height: number, context: CanvasRenderingContext2D): void;
  953. }
  954. }
  955. declare module BABYLON.GUI {
  956. /**
  957. * Root class for 2D containers
  958. * @see http://doc.babylonjs.com/how_to/gui#containers
  959. */
  960. class Container extends Control {
  961. name: string | undefined;
  962. /** @hidden */
  963. protected _children: Control[];
  964. /** @hidden */
  965. protected _measureForChildren: Measure;
  966. /** @hidden */
  967. protected _background: string;
  968. /** @hidden */
  969. protected _adaptWidthToChildren: boolean;
  970. /** @hidden */
  971. protected _adaptHeightToChildren: boolean;
  972. /** Gets or sets a boolean indicating if the container should try to adapt to its children height */
  973. adaptHeightToChildren: boolean;
  974. /** Gets or sets a boolean indicating if the container should try to adapt to its children width */
  975. adaptWidthToChildren: boolean;
  976. /** Gets or sets background color */
  977. background: string;
  978. /** Gets the list of children */
  979. readonly children: Control[];
  980. /**
  981. * Creates a new Container
  982. * @param name defines the name of the container
  983. */
  984. constructor(name?: string | undefined);
  985. protected _getTypeName(): string;
  986. /**
  987. * Gets a child using its name
  988. * @param name defines the child name to look for
  989. * @returns the child control if found
  990. */
  991. getChildByName(name: string): Nullable<Control>;
  992. /**
  993. * Gets a child using its type and its name
  994. * @param name defines the child name to look for
  995. * @param type defines the child type to look for
  996. * @returns the child control if found
  997. */
  998. getChildByType(name: string, type: string): Nullable<Control>;
  999. /**
  1000. * Search for a specific control in children
  1001. * @param control defines the control to look for
  1002. * @returns true if the control is in child list
  1003. */
  1004. containsControl(control: Control): boolean;
  1005. /**
  1006. * Adds a new control to the current container
  1007. * @param control defines the control to add
  1008. * @returns the current container
  1009. */
  1010. addControl(control: Nullable<Control>): Container;
  1011. /**
  1012. * Removes a control from the current container
  1013. * @param control defines the control to remove
  1014. * @returns the current container
  1015. */
  1016. removeControl(control: Control): Container;
  1017. /** @hidden */
  1018. _reOrderControl(control: Control): void;
  1019. /** @hidden */
  1020. _markMatrixAsDirty(): void;
  1021. /** @hidden */
  1022. _markAllAsDirty(): void;
  1023. /** @hidden */
  1024. protected _localDraw(context: CanvasRenderingContext2D): void;
  1025. /** @hidden */
  1026. _link(root: Nullable<Container>, host: AdvancedDynamicTexture): void;
  1027. /** @hidden */
  1028. _draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  1029. /** @hidden */
  1030. _processPicking(x: number, y: number, type: number, pointerId: number, buttonIndex: number): boolean;
  1031. /** @hidden */
  1032. protected _clipForChildren(context: CanvasRenderingContext2D): void;
  1033. /** @hidden */
  1034. protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  1035. /** Releases associated resources */
  1036. dispose(): void;
  1037. }
  1038. }
  1039. declare module BABYLON.GUI {
  1040. /**
  1041. * Class used to create a 2D stack panel container
  1042. */
  1043. class StackPanel extends Container {
  1044. name: string | undefined;
  1045. private _isVertical;
  1046. private _manualWidth;
  1047. private _manualHeight;
  1048. private _doNotTrackManualChanges;
  1049. private _tempMeasureStore;
  1050. /** Gets or sets a boolean indicating if the stack panel is vertical or horizontal*/
  1051. isVertical: boolean;
  1052. /** Gets or sets panel width */
  1053. width: string | number;
  1054. /** Gets or sets panel height */
  1055. height: string | number;
  1056. /**
  1057. * Creates a new StackPanel
  1058. * @param name defines control name
  1059. */
  1060. constructor(name?: string | undefined);
  1061. protected _getTypeName(): string;
  1062. protected _preMeasure(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  1063. }
  1064. }
  1065. declare module BABYLON.GUI {
  1066. /** Class used to create rectangle container */
  1067. class Rectangle extends Container {
  1068. name: string | undefined;
  1069. private _thickness;
  1070. private _cornerRadius;
  1071. /** Gets or sets border thickness */
  1072. thickness: number;
  1073. /** Gets or sets the corner radius angle */
  1074. cornerRadius: number;
  1075. /**
  1076. * Creates a new Rectangle
  1077. * @param name defines the control name
  1078. */
  1079. constructor(name?: string | undefined);
  1080. protected _getTypeName(): string;
  1081. protected _localDraw(context: CanvasRenderingContext2D): void;
  1082. protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  1083. private _drawRoundedRect(context, offset?);
  1084. protected _clipForChildren(context: CanvasRenderingContext2D): void;
  1085. }
  1086. }
  1087. declare module BABYLON.GUI {
  1088. /** Class used to create 2D ellipse containers */
  1089. class Ellipse extends Container {
  1090. name: string | undefined;
  1091. private _thickness;
  1092. /** Gets or sets border thickness */
  1093. thickness: number;
  1094. /**
  1095. * Creates a new Ellipse
  1096. * @param name defines the control name
  1097. */
  1098. constructor(name?: string | undefined);
  1099. protected _getTypeName(): string;
  1100. protected _localDraw(context: CanvasRenderingContext2D): void;
  1101. protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  1102. protected _clipForChildren(context: CanvasRenderingContext2D): void;
  1103. }
  1104. }
  1105. declare module BABYLON.GUI {
  1106. /** Class used to render 2D lines */
  1107. class Line extends Control {
  1108. name: string | undefined;
  1109. private _lineWidth;
  1110. private _x1;
  1111. private _y1;
  1112. private _x2;
  1113. private _y2;
  1114. private _dash;
  1115. private _connectedControl;
  1116. private _connectedControlDirtyObserver;
  1117. /** Gets or sets the dash pattern */
  1118. dash: Array<number>;
  1119. /** Gets or sets the control connected with the line end */
  1120. connectedControl: Control;
  1121. /** Gets or sets start coordinates on X axis */
  1122. x1: string | number;
  1123. /** Gets or sets start coordinates on Y axis */
  1124. y1: string | number;
  1125. /** Gets or sets end coordinates on X axis */
  1126. x2: string | number;
  1127. /** Gets or sets end coordinates on Y axis */
  1128. y2: string | number;
  1129. /** Gets or sets line width */
  1130. lineWidth: number;
  1131. /** Gets or sets horizontal alignment */
  1132. horizontalAlignment: number;
  1133. /** Gets or sets vertical alignment */
  1134. verticalAlignment: number;
  1135. private readonly _effectiveX2;
  1136. private readonly _effectiveY2;
  1137. /**
  1138. * Creates a new Line
  1139. * @param name defines the control name
  1140. */
  1141. constructor(name?: string | undefined);
  1142. protected _getTypeName(): string;
  1143. _draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  1144. _measure(): void;
  1145. protected _computeAlignment(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  1146. /**
  1147. * Move one end of the line given 3D cartesian coordinates.
  1148. * @param position Targeted world position
  1149. * @param scene Scene
  1150. * @param end (opt) Set to true to assign x2 and y2 coordinates of the line. Default assign to x1 and y1.
  1151. */
  1152. moveToVector3(position: Vector3, scene: Scene, end?: boolean): void;
  1153. /**
  1154. * Move one end of the line to a position in screen absolute space.
  1155. * @param projectedPosition Position in screen absolute space (X, Y)
  1156. * @param end (opt) Set to true to assign x2 and y2 coordinates of the line. Default assign to x1 and y1.
  1157. */
  1158. _moveToProjectedPosition(projectedPosition: Vector3, end?: boolean): void;
  1159. }
  1160. }
  1161. declare module BABYLON.GUI {
  1162. /**
  1163. * Class used to create slider controls
  1164. */
  1165. class Slider extends Control {
  1166. name: string | undefined;
  1167. private _thumbWidth;
  1168. private _minimum;
  1169. private _maximum;
  1170. private _value;
  1171. private _background;
  1172. private _borderColor;
  1173. private _barOffset;
  1174. private _isThumbCircle;
  1175. private _isThumbClamped;
  1176. /** Observable raised when the sldier value changes */
  1177. onValueChangedObservable: Observable<number>;
  1178. /** Gets or sets border color */
  1179. borderColor: string;
  1180. /** Gets or sets background color */
  1181. background: string;
  1182. /** Gets or sets main bar offset */
  1183. barOffset: string | number;
  1184. /** Gets main bar offset in pixels*/
  1185. readonly barOffsetInPixels: number;
  1186. /** Gets or sets thumb width */
  1187. thumbWidth: string | number;
  1188. /** Gets thumb width in pixels */
  1189. readonly thumbWidthInPixels: number;
  1190. /** Gets or sets minimum value */
  1191. minimum: number;
  1192. /** Gets or sets maximum value */
  1193. maximum: number;
  1194. /** Gets or sets current value */
  1195. value: number;
  1196. /** Gets or sets a boolean indicating if the thumb should be round or square */
  1197. isThumbCircle: boolean;
  1198. /** Gets or sets a value indicating if the thumb can go over main bar extends */
  1199. isThumbClamped: boolean;
  1200. /**
  1201. * Creates a new Slider
  1202. * @param name defines the control name
  1203. */
  1204. constructor(name?: string | undefined);
  1205. protected _getTypeName(): string;
  1206. _draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  1207. private _pointerIsDown;
  1208. private _updateValueFromPointer(x, y);
  1209. _onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
  1210. _onPointerMove(target: Control, coordinates: Vector2): void;
  1211. _onPointerUp(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean): void;
  1212. }
  1213. }
  1214. declare module BABYLON.GUI {
  1215. /**
  1216. * Class used to represent a 2D checkbox
  1217. */
  1218. class Checkbox extends Control {
  1219. name: string | undefined;
  1220. private _isChecked;
  1221. private _background;
  1222. private _checkSizeRatio;
  1223. private _thickness;
  1224. /** Gets or sets border thickness */
  1225. thickness: number;
  1226. /**
  1227. * Observable raised when isChecked property changes
  1228. */
  1229. onIsCheckedChangedObservable: Observable<boolean>;
  1230. /** Gets or sets a value indicating the ratio between overall size and check size */
  1231. checkSizeRatio: number;
  1232. /** Gets or sets background color */
  1233. background: string;
  1234. /** Gets or sets a boolean indicating if the checkbox is checked or not */
  1235. isChecked: boolean;
  1236. /**
  1237. * Creates a new CheckBox
  1238. * @param name defines the control name
  1239. */
  1240. constructor(name?: string | undefined);
  1241. protected _getTypeName(): string;
  1242. /** @hidden */
  1243. _draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  1244. /** @hidden */
  1245. _onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
  1246. }
  1247. }
  1248. declare module BABYLON.GUI {
  1249. /**
  1250. * Class used to create radio button controls
  1251. */
  1252. class RadioButton extends Control {
  1253. name: string | undefined;
  1254. private _isChecked;
  1255. private _background;
  1256. private _checkSizeRatio;
  1257. private _thickness;
  1258. /** Gets or sets border thickness */
  1259. thickness: number;
  1260. /** Gets or sets group name */
  1261. group: string;
  1262. /** Observable raised when isChecked is changed */
  1263. onIsCheckedChangedObservable: Observable<boolean>;
  1264. /** Gets or sets a value indicating the ratio between overall size and check size */
  1265. checkSizeRatio: number;
  1266. /** Gets or sets background color */
  1267. background: string;
  1268. /** Gets or sets a boolean indicating if the checkbox is checked or not */
  1269. isChecked: boolean;
  1270. /**
  1271. * Creates a new RadioButton
  1272. * @param name defines the control name
  1273. */
  1274. constructor(name?: string | undefined);
  1275. protected _getTypeName(): string;
  1276. _draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  1277. _onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
  1278. }
  1279. }
  1280. declare module BABYLON.GUI {
  1281. /**
  1282. * Class used to create text block control
  1283. */
  1284. class TextBlock extends Control {
  1285. /**
  1286. * Defines the name of the control
  1287. */
  1288. name: string | undefined;
  1289. private _text;
  1290. private _textWrapping;
  1291. private _textHorizontalAlignment;
  1292. private _textVerticalAlignment;
  1293. private _lines;
  1294. private _resizeToFit;
  1295. private _lineSpacing;
  1296. private _outlineWidth;
  1297. private _outlineColor;
  1298. /**
  1299. * An event triggered after the text is changed
  1300. */
  1301. onTextChangedObservable: Observable<TextBlock>;
  1302. /**
  1303. * An event triggered after the text was broken up into lines
  1304. */
  1305. onLinesReadyObservable: Observable<TextBlock>;
  1306. /**
  1307. * Return the line list (you may need to use the onLinesReadyObservable to make sure the list is ready)
  1308. */
  1309. readonly lines: any[];
  1310. /**
  1311. * Gets or sets an boolean indicating that the TextBlock will be resized to fit container
  1312. */
  1313. /**
  1314. * Gets or sets an boolean indicating that the TextBlock will be resized to fit container
  1315. */
  1316. resizeToFit: boolean;
  1317. /**
  1318. * Gets or sets a boolean indicating if text must be wrapped
  1319. */
  1320. /**
  1321. * Gets or sets a boolean indicating if text must be wrapped
  1322. */
  1323. textWrapping: boolean;
  1324. /**
  1325. * Gets or sets text to display
  1326. */
  1327. /**
  1328. * Gets or sets text to display
  1329. */
  1330. text: string;
  1331. /**
  1332. * Gets or sets text horizontal alignment (BABYLON.GUI.Control.HORIZONTAL_ALIGNMENT_CENTER by default)
  1333. */
  1334. /**
  1335. * Gets or sets text horizontal alignment (BABYLON.GUI.Control.HORIZONTAL_ALIGNMENT_CENTER by default)
  1336. */
  1337. textHorizontalAlignment: number;
  1338. /**
  1339. * Gets or sets text vertical alignment (BABYLON.GUI.Control.VERTICAL_ALIGNMENT_CENTER by default)
  1340. */
  1341. /**
  1342. * Gets or sets text vertical alignment (BABYLON.GUI.Control.VERTICAL_ALIGNMENT_CENTER by default)
  1343. */
  1344. textVerticalAlignment: number;
  1345. /**
  1346. * Gets or sets line spacing value
  1347. */
  1348. /**
  1349. * Gets or sets line spacing value
  1350. */
  1351. lineSpacing: string | number;
  1352. /**
  1353. * Gets or sets outlineWidth of the text to display
  1354. */
  1355. /**
  1356. * Gets or sets outlineWidth of the text to display
  1357. */
  1358. outlineWidth: number;
  1359. /**
  1360. * Gets or sets outlineColor of the text to display
  1361. */
  1362. /**
  1363. * Gets or sets outlineColor of the text to display
  1364. */
  1365. outlineColor: string;
  1366. /**
  1367. * Creates a new TextBlock object
  1368. * @param name defines the name of the control
  1369. * @param text defines the text to display (emptry string by default)
  1370. */
  1371. constructor(
  1372. /**
  1373. * Defines the name of the control
  1374. */
  1375. name?: string | undefined, text?: string);
  1376. protected _getTypeName(): string;
  1377. private _drawText(text, textWidth, y, context);
  1378. /** @hidden */
  1379. _draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  1380. protected _applyStates(context: CanvasRenderingContext2D): void;
  1381. protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  1382. protected _parseLine(line: string | undefined, context: CanvasRenderingContext2D): object;
  1383. protected _parseLineWithTextWrapping(line: string | undefined, context: CanvasRenderingContext2D): object;
  1384. protected _renderLines(context: CanvasRenderingContext2D): void;
  1385. dispose(): void;
  1386. }
  1387. }
  1388. declare var DOMImage: new (width?: number | undefined, height?: number | undefined) => HTMLImageElement;
  1389. declare module BABYLON.GUI {
  1390. /**
  1391. * Class used to create 2D images
  1392. */
  1393. class Image extends Control {
  1394. name: string | undefined;
  1395. private _domImage;
  1396. private _imageWidth;
  1397. private _imageHeight;
  1398. private _loaded;
  1399. private _stretch;
  1400. private _source;
  1401. private _autoScale;
  1402. private _sourceLeft;
  1403. private _sourceTop;
  1404. private _sourceWidth;
  1405. private _sourceHeight;
  1406. private _cellWidth;
  1407. private _cellHeight;
  1408. private _cellId;
  1409. /**
  1410. * Gets or sets the left coordinate in the source image
  1411. */
  1412. sourceLeft: number;
  1413. /**
  1414. * Gets or sets the top coordinate in the source image
  1415. */
  1416. sourceTop: number;
  1417. /**
  1418. * Gets or sets the width to capture in the source image
  1419. */
  1420. sourceWidth: number;
  1421. /**
  1422. * Gets or sets the height to capture in the source image
  1423. */
  1424. sourceHeight: number;
  1425. /**
  1426. * Gets or sets a boolean indicating if the image can force its container to adapt its size
  1427. * @see http://doc.babylonjs.com/how_to/gui#image
  1428. */
  1429. autoScale: boolean;
  1430. /** Gets or sets the streching mode used by the image */
  1431. stretch: number;
  1432. /**
  1433. * Gets or sets the internal DOM image used to render the control
  1434. */
  1435. domImage: HTMLImageElement;
  1436. private _onImageLoaded();
  1437. /**
  1438. * Gets or sets image source url
  1439. */
  1440. source: Nullable<string>;
  1441. /**
  1442. * Gets or sets the cell width to use when animation sheet is enabled
  1443. * @see http://doc.babylonjs.com/how_to/gui#image
  1444. */
  1445. cellWidth: number;
  1446. /**
  1447. * Gets or sets the cell height to use when animation sheet is enabled
  1448. * @see http://doc.babylonjs.com/how_to/gui#image
  1449. */
  1450. cellHeight: number;
  1451. /**
  1452. * Gets or sets the cell id to use (this will turn on the animation sheet mode)
  1453. * @see http://doc.babylonjs.com/how_to/gui#image
  1454. */
  1455. cellId: number;
  1456. /**
  1457. * Creates a new Image
  1458. * @param name defines the control name
  1459. * @param url defines the image url
  1460. */
  1461. constructor(name?: string | undefined, url?: Nullable<string>);
  1462. protected _getTypeName(): string;
  1463. /** Force the control to synchronize with its content */
  1464. synchronizeSizeWithContent(): void;
  1465. _draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  1466. private static _STRETCH_NONE;
  1467. private static _STRETCH_FILL;
  1468. private static _STRETCH_UNIFORM;
  1469. private static _STRETCH_EXTEND;
  1470. /** STRETCH_NONE */
  1471. static readonly STRETCH_NONE: number;
  1472. /** STRETCH_FILL */
  1473. static readonly STRETCH_FILL: number;
  1474. /** STRETCH_UNIFORM */
  1475. static readonly STRETCH_UNIFORM: number;
  1476. /** STRETCH_EXTEND */
  1477. static readonly STRETCH_EXTEND: number;
  1478. }
  1479. }
  1480. declare module BABYLON.GUI {
  1481. /**
  1482. * Class used to create 2D buttons
  1483. */
  1484. class Button extends Rectangle {
  1485. name: string | undefined;
  1486. /**
  1487. * Function called to generate a pointer enter animation
  1488. */
  1489. pointerEnterAnimation: () => void;
  1490. /**
  1491. * Function called to generate a pointer out animation
  1492. */
  1493. pointerOutAnimation: () => void;
  1494. /**
  1495. * Function called to generate a pointer down animation
  1496. */
  1497. pointerDownAnimation: () => void;
  1498. /**
  1499. * Function called to generate a pointer up animation
  1500. */
  1501. pointerUpAnimation: () => void;
  1502. /**
  1503. * Creates a new Button
  1504. * @param name defines the name of the button
  1505. */
  1506. constructor(name?: string | undefined);
  1507. protected _getTypeName(): string;
  1508. /** @hidden */
  1509. _processPicking(x: number, y: number, type: number, pointerId: number, buttonIndex: number): boolean;
  1510. /** @hidden */
  1511. _onPointerEnter(target: Control): boolean;
  1512. /** @hidden */
  1513. _onPointerOut(target: Control): void;
  1514. /** @hidden */
  1515. _onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
  1516. /** @hidden */
  1517. _onPointerUp(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean): void;
  1518. /**
  1519. * Creates a new button made with an image and a text
  1520. * @param name defines the name of the button
  1521. * @param text defines the text of the button
  1522. * @param imageUrl defines the url of the image
  1523. * @returns a new Button
  1524. */
  1525. static CreateImageButton(name: string, text: string, imageUrl: string): Button;
  1526. /**
  1527. * Creates a new button made with an image
  1528. * @param name defines the name of the button
  1529. * @param imageUrl defines the url of the image
  1530. * @returns a new Button
  1531. */
  1532. static CreateImageOnlyButton(name: string, imageUrl: string): Button;
  1533. /**
  1534. * Creates a new button made with a text
  1535. * @param name defines the name of the button
  1536. * @param text defines the text of the button
  1537. * @returns a new Button
  1538. */
  1539. static CreateSimpleButton(name: string, text: string): Button;
  1540. /**
  1541. * Creates a new button made with an image and a centered text
  1542. * @param name defines the name of the button
  1543. * @param text defines the text of the button
  1544. * @param imageUrl defines the url of the image
  1545. * @returns a new Button
  1546. */
  1547. static CreateImageWithCenterTextButton(name: string, text: string, imageUrl: string): Button;
  1548. }
  1549. }
  1550. declare module BABYLON.GUI {
  1551. /** Class used to create color pickers */
  1552. class ColorPicker extends Control {
  1553. name: string | undefined;
  1554. private _colorWheelCanvas;
  1555. private _value;
  1556. private _tmpColor;
  1557. private _pointerStartedOnSquare;
  1558. private _pointerStartedOnWheel;
  1559. private _squareLeft;
  1560. private _squareTop;
  1561. private _squareSize;
  1562. private _h;
  1563. private _s;
  1564. private _v;
  1565. /**
  1566. * Observable raised when the value changes
  1567. */
  1568. onValueChangedObservable: Observable<Color3>;
  1569. /** Gets or sets the color of the color picker */
  1570. value: Color3;
  1571. /** Gets or sets control width */
  1572. width: string | number;
  1573. /** Gets or sets control height */
  1574. height: string | number;
  1575. /** Gets or sets control size */
  1576. size: string | number;
  1577. /**
  1578. * Creates a new ColorPicker
  1579. * @param name defines the control name
  1580. */
  1581. constructor(name?: string | undefined);
  1582. protected _getTypeName(): string;
  1583. private _updateSquareProps();
  1584. private _drawGradientSquare(hueValue, left, top, width, height, context);
  1585. private _drawCircle(centerX, centerY, radius, context);
  1586. private _createColorWheelCanvas(radius, thickness);
  1587. private _RGBtoHSV(color, result);
  1588. private _HSVtoRGB(hue, saturation, value, result);
  1589. /** @hidden */
  1590. _draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  1591. private _pointerIsDown;
  1592. private _updateValueFromPointer(x, y);
  1593. private _isPointOnSquare(coordinates);
  1594. private _isPointOnWheel(coordinates);
  1595. _onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
  1596. _onPointerMove(target: Control, coordinates: Vector2): void;
  1597. _onPointerUp(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean): void;
  1598. }
  1599. }
  1600. declare module BABYLON.GUI {
  1601. /**
  1602. * Class used to create input text control
  1603. */
  1604. class InputText extends Control implements IFocusableControl {
  1605. name: string | undefined;
  1606. private _text;
  1607. private _placeholderText;
  1608. private _background;
  1609. private _focusedBackground;
  1610. private _placeholderColor;
  1611. private _thickness;
  1612. private _margin;
  1613. private _autoStretchWidth;
  1614. private _maxWidth;
  1615. private _isFocused;
  1616. private _blinkTimeout;
  1617. private _blinkIsEven;
  1618. private _cursorOffset;
  1619. private _scrollLeft;
  1620. private _textWidth;
  1621. private _clickedCoordinate;
  1622. /** Gets or sets a string representing the message displayed on mobile when the control gets the focus */
  1623. promptMessage: string;
  1624. /** Observable raised when the text changes */
  1625. onTextChangedObservable: Observable<InputText>;
  1626. /** Observable raised when the control gets the focus */
  1627. onFocusObservable: Observable<InputText>;
  1628. /** Observable raised when the control loses the focus */
  1629. onBlurObservable: Observable<InputText>;
  1630. /** Gets or sets the maximum width allowed by the control */
  1631. maxWidth: string | number;
  1632. /** Gets the maximum width allowed by the control in pixels */
  1633. readonly maxWidthInPixels: number;
  1634. /** Gets or sets control margin */
  1635. margin: string;
  1636. /** Gets control margin in pixels */
  1637. readonly marginInPixels: number;
  1638. /** Gets or sets a boolean indicating if the control can auto stretch its width to adapt to the text */
  1639. autoStretchWidth: boolean;
  1640. /** Gets or sets border thickness */
  1641. thickness: number;
  1642. /** Gets or sets the background color when focused */
  1643. focusedBackground: string;
  1644. /** Gets or sets the background color */
  1645. background: string;
  1646. /** Gets or sets the placeholder color */
  1647. placeholderColor: string;
  1648. /** Gets or sets the text displayed when the control is empty */
  1649. placeholderText: string;
  1650. /** Gets or sets the text displayed in the control */
  1651. text: string;
  1652. /** Gets or sets control width */
  1653. width: string | number;
  1654. /**
  1655. * Creates a new InputText
  1656. * @param name defines the control name
  1657. * @param text defines the text of the control
  1658. */
  1659. constructor(name?: string | undefined, text?: string);
  1660. /** @hidden */
  1661. onBlur(): void;
  1662. /** @hidden */
  1663. onFocus(): void;
  1664. protected _getTypeName(): string;
  1665. /** @hidden */
  1666. processKey(keyCode: number, key?: string): void;
  1667. /** @hidden */
  1668. processKeyboard(evt: KeyboardEvent): void;
  1669. _draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  1670. _onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
  1671. _onPointerUp(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean): void;
  1672. dispose(): void;
  1673. }
  1674. }
  1675. declare module BABYLON.GUI {
  1676. /**
  1677. * Class used to store key control properties
  1678. */
  1679. class KeyPropertySet {
  1680. /** Width */
  1681. width?: string;
  1682. /** Height */
  1683. height?: string;
  1684. /** Left padding */
  1685. paddingLeft?: string;
  1686. /** Right padding */
  1687. paddingRight?: string;
  1688. /** Top padding */
  1689. paddingTop?: string;
  1690. /** Bottom padding */
  1691. paddingBottom?: string;
  1692. /** Foreground color */
  1693. color?: string;
  1694. /** Background color */
  1695. background?: string;
  1696. }
  1697. /**
  1698. * Class used to create virtual keyboard
  1699. */
  1700. class VirtualKeyboard extends StackPanel {
  1701. /** Observable raised when a key is pressed */
  1702. onKeyPressObservable: Observable<string>;
  1703. /** Gets or sets default key button width */
  1704. defaultButtonWidth: string;
  1705. /** Gets or sets default key button height */
  1706. defaultButtonHeight: string;
  1707. /** Gets or sets default key button left padding */
  1708. defaultButtonPaddingLeft: string;
  1709. /** Gets or sets default key button right padding */
  1710. defaultButtonPaddingRight: string;
  1711. /** Gets or sets default key button top padding */
  1712. defaultButtonPaddingTop: string;
  1713. /** Gets or sets default key button bottom padding */
  1714. defaultButtonPaddingBottom: string;
  1715. /** Gets or sets default key button foreground color */
  1716. defaultButtonColor: string;
  1717. /** Gets or sets default key button background color */
  1718. defaultButtonBackground: string;
  1719. /** Gets or sets shift button foreground color */
  1720. shiftButtonColor: string;
  1721. /** Gets or sets shift button thickness*/
  1722. selectedShiftThickness: number;
  1723. /** Gets shift key state */
  1724. shiftState: number;
  1725. protected _getTypeName(): string;
  1726. private _createKey(key, propertySet);
  1727. /**
  1728. * Adds a new row of keys
  1729. * @param keys defines the list of keys to add
  1730. * @param propertySets defines the associated property sets
  1731. */
  1732. addKeysRow(keys: Array<string>, propertySets?: Array<KeyPropertySet>): void;
  1733. /**
  1734. * Set the shift key to a specific state
  1735. * @param shiftState defines the new shift state
  1736. */
  1737. applyShiftState(shiftState: number): void;
  1738. private _connectedInputText;
  1739. private _onFocusObserver;
  1740. private _onBlurObserver;
  1741. private _onKeyPressObserver;
  1742. /** Gets the input text control attached with the keyboard */
  1743. readonly connectedInputText: Nullable<InputText>;
  1744. /**
  1745. * Connects the keyboard with an input text control
  1746. * @param input defines the target control
  1747. */
  1748. connect(input: InputText): void;
  1749. /**
  1750. * Disconnects the keyboard from an input text control
  1751. */
  1752. disconnect(): void;
  1753. /**
  1754. * Creates a new keyboard using a default layout
  1755. * @returns a new VirtualKeyboard
  1756. */
  1757. static CreateDefaultLayout(): VirtualKeyboard;
  1758. }
  1759. }
  1760. declare module BABYLON.GUI {
  1761. /**
  1762. * Class used to create multi line control
  1763. */
  1764. class MultiLine extends Control {
  1765. name: string | undefined;
  1766. private _lineWidth;
  1767. private _dash;
  1768. private _points;
  1769. private _minX;
  1770. private _minY;
  1771. private _maxX;
  1772. private _maxY;
  1773. /**
  1774. * Creates a new MultiLine
  1775. * @param name defines the control name
  1776. */
  1777. constructor(name?: string | undefined);
  1778. /** Gets or sets dash pattern */
  1779. dash: Array<number>;
  1780. /**
  1781. * Gets point stored at specified index
  1782. * @param index defines the index to look for
  1783. * @returns the requested point if found
  1784. */
  1785. getAt(index: number): MultiLinePoint;
  1786. /** Function called when a point is updated */
  1787. onPointUpdate: () => void;
  1788. /**
  1789. * Adds new points to the point collection
  1790. * @param items defines the list of items (mesh, control or 2d coordiantes) to add
  1791. * @returns the list of created MultiLinePoint
  1792. */
  1793. add(...items: (AbstractMesh | Control | {
  1794. x: string | number;
  1795. y: string | number;
  1796. })[]): MultiLinePoint[];
  1797. /**
  1798. * Adds a new point to the point collection
  1799. * @param item defines the item (mesh, control or 2d coordiantes) to add
  1800. * @returns the created MultiLinePoint
  1801. */
  1802. push(item?: (AbstractMesh | Control | {
  1803. x: string | number;
  1804. y: string | number;
  1805. })): MultiLinePoint;
  1806. /**
  1807. * Remove a specific value or point from the active point collection
  1808. * @param value defines the value or point to remove
  1809. */
  1810. remove(value: number | MultiLinePoint): void;
  1811. /** Gets or sets line width */
  1812. lineWidth: number;
  1813. horizontalAlignment: number;
  1814. verticalAlignment: number;
  1815. protected _getTypeName(): string;
  1816. _draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  1817. protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  1818. _measure(): void;
  1819. protected _computeAlignment(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  1820. dispose(): void;
  1821. }
  1822. }
  1823. declare module BABYLON.GUI {
  1824. /**
  1825. * Class used to manage 3D user interface
  1826. * @see http://doc.babylonjs.com/how_to/gui3d
  1827. */
  1828. class GUI3DManager implements BABYLON.IDisposable {
  1829. private _scene;
  1830. private _sceneDisposeObserver;
  1831. private _utilityLayer;
  1832. private _rootContainer;
  1833. private _pointerObserver;
  1834. private _pointerOutObserver;
  1835. /** @hidden */
  1836. _lastPickedControl: Control3D;
  1837. /** @hidden */
  1838. _lastControlOver: {
  1839. [pointerId: number]: Control3D;
  1840. };
  1841. /** @hidden */
  1842. _lastControlDown: {
  1843. [pointerId: number]: Control3D;
  1844. };
  1845. /**
  1846. * Observable raised when the point picked by the pointer events changed
  1847. */
  1848. onPickedPointChangedObservable: Observable<Nullable<Vector3>>;
  1849. /** @hidden */
  1850. _sharedMaterials: {
  1851. [key: string]: Material;
  1852. };
  1853. /** Gets the hosting scene */
  1854. readonly scene: Scene;
  1855. /** Gets associated utility layer */
  1856. readonly utilityLayer: Nullable<UtilityLayerRenderer>;
  1857. /**
  1858. * Creates a new GUI3DManager
  1859. * @param scene
  1860. */
  1861. constructor(scene?: Scene);
  1862. private _handlePointerOut(pointerId, isPointerUp);
  1863. private _doPicking(pi);
  1864. /**
  1865. * Gets the root container
  1866. */
  1867. readonly rootContainer: Container3D;
  1868. /**
  1869. * Gets a boolean indicating if the given control is in the root child list
  1870. * @param control defines the control to check
  1871. * @returns true if the control is in the root child list
  1872. */
  1873. containsControl(control: Control3D): boolean;
  1874. /**
  1875. * Adds a control to the root child list
  1876. * @param control defines the control to add
  1877. * @returns the current manager
  1878. */
  1879. addControl(control: Control3D): GUI3DManager;
  1880. /**
  1881. * Removes a control from the root child list
  1882. * @param control defines the control to remove
  1883. * @returns the current container
  1884. */
  1885. removeControl(control: Control3D): GUI3DManager;
  1886. /**
  1887. * Releases all associated resources
  1888. */
  1889. dispose(): void;
  1890. }
  1891. }
  1892. declare module BABYLON.GUI {
  1893. /** @hidden */
  1894. class FluentMaterialDefines extends MaterialDefines {
  1895. INNERGLOW: boolean;
  1896. BORDER: boolean;
  1897. HOVERLIGHT: boolean;
  1898. constructor();
  1899. }
  1900. /**
  1901. * Class used to render controls with fluent desgin
  1902. */
  1903. class FluentMaterial extends PushMaterial {
  1904. /**
  1905. * Gets or sets inner glow intensity. A value of 0 means no glow (default is 0.5)
  1906. */
  1907. innerGlowColorIntensity: number;
  1908. /**
  1909. * Gets or sets the inner glow color (white by default)
  1910. */
  1911. innerGlowColor: Color3;
  1912. /**
  1913. * Gets or sets alpha value (default is 1.0)
  1914. */
  1915. alpha: number;
  1916. /**
  1917. * Gets or sets the albedo color (Default is Color3(0.3, 0.35, 0.4))
  1918. */
  1919. albedoColor: Color3;
  1920. /**
  1921. * Gets or sets a boolean indicating if borders must be rendered (default is false)
  1922. */
  1923. renderBorders: boolean;
  1924. /**
  1925. * Gets or sets border width (default is 0.5)
  1926. */
  1927. borderWidth: number;
  1928. /**
  1929. * Gets or sets a value indicating the smoothing value applied to border edges (0.02 by default)
  1930. */
  1931. edgeSmoothingValue: number;
  1932. /**
  1933. * Gets or sets the minimum value that can be applied to border width (default is 0.1)
  1934. */
  1935. borderMinValue: number;
  1936. /**
  1937. * Gets or sets a boolean indicating if hover light must be rendered (default is false)
  1938. */
  1939. renderHoverLight: boolean;
  1940. /**
  1941. * Gets or sets the radius used to render the hover light (default is 0.15)
  1942. */
  1943. hoverRadius: number;
  1944. /**
  1945. * Gets or sets the color used to render the hover light (default is Color4(0.3, 0.3, 0.3, 1.0))
  1946. */
  1947. hoverColor: Color4;
  1948. /**
  1949. * Gets or sets the hover light position in world space (default is Vector3.Zero())
  1950. */
  1951. hoverPosition: Vector3;
  1952. /**
  1953. * Creates a new Fluent material
  1954. * @param name defines the name of the material
  1955. * @param scene defines the hosting scene
  1956. */
  1957. constructor(name: string, scene: Scene);
  1958. needAlphaBlending(): boolean;
  1959. needAlphaTesting(): boolean;
  1960. getAlphaTestTexture(): Nullable<BaseTexture>;
  1961. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  1962. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  1963. getActiveTextures(): BaseTexture[];
  1964. hasTexture(texture: BaseTexture): boolean;
  1965. dispose(forceDisposeEffect?: boolean): void;
  1966. clone(name: string): FluentMaterial;
  1967. serialize(): any;
  1968. getClassName(): string;
  1969. static Parse(source: any, scene: Scene, rootUrl: string): FluentMaterial;
  1970. }
  1971. }
  1972. declare module BABYLON.GUI {
  1973. /**
  1974. * Class used to transport Vector3 information for pointer events
  1975. */
  1976. class Vector3WithInfo extends Vector3 {
  1977. /** defines the current mouse button index */
  1978. buttonIndex: number;
  1979. /**
  1980. * Creates a new Vector3WithInfo
  1981. * @param source defines the vector3 data to transport
  1982. * @param buttonIndex defines the current mouse button index
  1983. */
  1984. constructor(source: Vector3,
  1985. /** defines the current mouse button index */
  1986. buttonIndex?: number);
  1987. }
  1988. }
  1989. declare module BABYLON.GUI {
  1990. /**
  1991. * Class used as base class for controls
  1992. */
  1993. class Control3D implements IDisposable, IBehaviorAware<Control3D> {
  1994. /** Defines the control name */
  1995. name: string | undefined;
  1996. /** @hidden */
  1997. _host: GUI3DManager;
  1998. private _node;
  1999. private _downCount;
  2000. private _enterCount;
  2001. private _downPointerIds;
  2002. private _isVisible;
  2003. /** Gets or sets the control position in world space */
  2004. position: Vector3;
  2005. /** Gets or sets the control scaling in world space */
  2006. scaling: Vector3;
  2007. /** Callback used to start pointer enter animation */
  2008. pointerEnterAnimation: () => void;
  2009. /** Callback used to start pointer out animation */
  2010. pointerOutAnimation: () => void;
  2011. /** Callback used to start pointer down animation */
  2012. pointerDownAnimation: () => void;
  2013. /** Callback used to start pointer up animation */
  2014. pointerUpAnimation: () => void;
  2015. /**
  2016. * An event triggered when the pointer move over the control
  2017. */
  2018. onPointerMoveObservable: Observable<Vector3>;
  2019. /**
  2020. * An event triggered when the pointer move out of the control
  2021. */
  2022. onPointerOutObservable: Observable<Control3D>;
  2023. /**
  2024. * An event triggered when the pointer taps the control
  2025. */
  2026. onPointerDownObservable: Observable<Vector3WithInfo>;
  2027. /**
  2028. * An event triggered when pointer is up
  2029. */
  2030. onPointerUpObservable: Observable<Vector3WithInfo>;
  2031. /**
  2032. * An event triggered when a control is clicked on (with a mouse)
  2033. */
  2034. onPointerClickObservable: Observable<Vector3WithInfo>;
  2035. /**
  2036. * An event triggered when pointer enters the control
  2037. */
  2038. onPointerEnterObservable: Observable<Control3D>;
  2039. /**
  2040. * Gets or sets the parent container
  2041. */
  2042. parent: Nullable<Container3D>;
  2043. private _behaviors;
  2044. /**
  2045. * Gets the list of attached behaviors
  2046. * @see http://doc.babylonjs.com/features/behaviour
  2047. */
  2048. readonly behaviors: Behavior<Control3D>[];
  2049. /**
  2050. * Attach a behavior to the control
  2051. * @see http://doc.babylonjs.com/features/behaviour
  2052. * @param behavior defines the behavior to attach
  2053. * @returns the current control
  2054. */
  2055. addBehavior(behavior: Behavior<Control3D>): Control3D;
  2056. /**
  2057. * Remove an attached behavior
  2058. * @see http://doc.babylonjs.com/features/behaviour
  2059. * @param behavior defines the behavior to attach
  2060. * @returns the current control
  2061. */
  2062. removeBehavior(behavior: Behavior<Control3D>): Control3D;
  2063. /**
  2064. * Gets an attached behavior by name
  2065. * @param name defines the name of the behavior to look for
  2066. * @see http://doc.babylonjs.com/features/behaviour
  2067. * @returns null if behavior was not found else the requested behavior
  2068. */
  2069. getBehaviorByName(name: string): Nullable<Behavior<Control3D>>;
  2070. /** Gets or sets a boolean indicating if the control is visible */
  2071. isVisible: boolean;
  2072. /**
  2073. * Creates a new control
  2074. * @param name defines the control name
  2075. */
  2076. constructor(
  2077. /** Defines the control name */
  2078. name?: string | undefined);
  2079. /**
  2080. * Gets a string representing the class name
  2081. */
  2082. readonly typeName: string;
  2083. protected _getTypeName(): string;
  2084. /**
  2085. * Gets the transform node used by this control
  2086. */
  2087. readonly node: Nullable<TransformNode>;
  2088. /**
  2089. * Gets the mesh used to render this control
  2090. */
  2091. readonly mesh: Nullable<AbstractMesh>;
  2092. /**
  2093. * Link the control as child of the given node
  2094. * @param node defines the node to link to. Use null to unlink the control
  2095. * @returns the current control
  2096. */
  2097. linkToTransformNode(node: Nullable<TransformNode>): Control3D;
  2098. /** @hidden **/
  2099. _prepareNode(scene: Scene): void;
  2100. /**
  2101. * Node creation.
  2102. * Can be overriden by children
  2103. * @param scene defines the scene where the node must be attached
  2104. * @returns the attached node or null if none. Must return a Mesh or AbstractMesh if there is an atttached visible object
  2105. */
  2106. protected _createNode(scene: Scene): Nullable<TransformNode>;
  2107. /**
  2108. * Affect a material to the given mesh
  2109. * @param mesh defines the mesh which will represent the control
  2110. */
  2111. protected _affectMaterial(mesh: AbstractMesh): void;
  2112. /** @hidden */
  2113. _onPointerMove(target: Control3D, coordinates: Vector3): void;
  2114. /** @hidden */
  2115. _onPointerEnter(target: Control3D): boolean;
  2116. /** @hidden */
  2117. _onPointerOut(target: Control3D): void;
  2118. /** @hidden */
  2119. _onPointerDown(target: Control3D, coordinates: Vector3, pointerId: number, buttonIndex: number): boolean;
  2120. /** @hidden */
  2121. _onPointerUp(target: Control3D, coordinates: Vector3, pointerId: number, buttonIndex: number, notifyClick: boolean): void;
  2122. /** @hidden */
  2123. forcePointerUp(pointerId?: Nullable<number>): void;
  2124. /** @hidden */
  2125. _processObservables(type: number, pickedPoint: Vector3, pointerId: number, buttonIndex: number): boolean;
  2126. /** @hidden */
  2127. _disposeNode(): void;
  2128. /**
  2129. * Releases all associated resources
  2130. */
  2131. dispose(): void;
  2132. }
  2133. }
  2134. declare module BABYLON.GUI {
  2135. /**
  2136. * Class used to create containers for controls
  2137. */
  2138. class Container3D extends Control3D {
  2139. private _blockLayout;
  2140. /**
  2141. * Gets the list of child controls
  2142. */
  2143. protected _children: Control3D[];
  2144. /**
  2145. * Gets the list of child controls
  2146. */
  2147. readonly children: Array<Control3D>;
  2148. /**
  2149. * Gets or sets a boolean indicating if the layout must be blocked (default is false).
  2150. * This is helpful to optimize layout operation when adding multiple children in a row
  2151. */
  2152. blockLayout: boolean;
  2153. /**
  2154. * Creates a new container
  2155. * @param name defines the container name
  2156. */
  2157. constructor(name?: string);
  2158. /**
  2159. * Gets a boolean indicating if the given control is in the children of this control
  2160. * @param control defines the control to check
  2161. * @returns true if the control is in the child list
  2162. */
  2163. containsControl(control: Control3D): boolean;
  2164. /**
  2165. * Adds a control to the children of this control
  2166. * @param control defines the control to add
  2167. * @returns the current container
  2168. */
  2169. addControl(control: Control3D): Container3D;
  2170. /**
  2171. * This function will be called everytime a new control is added
  2172. */
  2173. protected _arrangeChildren(): void;
  2174. protected _createNode(scene: Scene): Nullable<TransformNode>;
  2175. /**
  2176. * Removes a control from the children of this control
  2177. * @param control defines the control to remove
  2178. * @returns the current container
  2179. */
  2180. removeControl(control: Control3D): Container3D;
  2181. protected _getTypeName(): string;
  2182. /**
  2183. * Releases all associated resources
  2184. */
  2185. dispose(): void;
  2186. /** Control rotation will remain unchanged */
  2187. static readonly UNSET_ORIENTATION: number;
  2188. /** Control will rotate to make it look at sphere central axis */
  2189. static readonly FACEORIGIN_ORIENTATION: number;
  2190. /** Control will rotate to make it look back at sphere central axis */
  2191. static readonly FACEORIGINREVERSED_ORIENTATION: number;
  2192. /** Control will rotate to look at z axis (0, 0, 1) */
  2193. static readonly FACEFORWARD_ORIENTATION: number;
  2194. /** Control will rotate to look at negative z axis (0, 0, -1) */
  2195. static readonly FACEFORWARDREVERSED_ORIENTATION: number;
  2196. }
  2197. }
  2198. declare module BABYLON.GUI {
  2199. /**
  2200. * Class used to create a button in 3D
  2201. */
  2202. class Button3D extends Control3D {
  2203. /** @hidden */
  2204. protected _currentMaterial: Material;
  2205. private _facadeTexture;
  2206. private _content;
  2207. private _contentResolution;
  2208. private _contentScaleRatio;
  2209. /**
  2210. * Gets or sets the texture resolution used to render content (512 by default)
  2211. */
  2212. contentResolution: int;
  2213. /**
  2214. * Gets or sets the texture scale ratio used to render content (2 by default)
  2215. */
  2216. contentScaleRatio: number;
  2217. protected _disposeFacadeTexture(): void;
  2218. protected _resetContent(): void;
  2219. /**
  2220. * Creates a new button
  2221. * @param name defines the control name
  2222. */
  2223. constructor(name?: string);
  2224. /**
  2225. * Gets or sets the GUI 2D content used to display the button's facade
  2226. */
  2227. content: Control;
  2228. /**
  2229. * Apply the facade texture (created from the content property).
  2230. * This function can be overloaded by child classes
  2231. * @param facadeTexture defines the AdvancedDynamicTexture to use
  2232. */
  2233. protected _applyFacade(facadeTexture: AdvancedDynamicTexture): void;
  2234. protected _getTypeName(): string;
  2235. protected _createNode(scene: Scene): TransformNode;
  2236. protected _affectMaterial(mesh: AbstractMesh): void;
  2237. /**
  2238. * Releases all associated resources
  2239. */
  2240. dispose(): void;
  2241. }
  2242. }
  2243. declare module BABYLON.GUI {
  2244. /**
  2245. * Class used to create a holographic button in 3D
  2246. */
  2247. class HolographicButton extends Button3D {
  2248. private _backPlate;
  2249. private _textPlate;
  2250. private _frontPlate;
  2251. private _text;
  2252. private _imageUrl;
  2253. private _shareMaterials;
  2254. private _frontMaterial;
  2255. private _backMaterial;
  2256. private _plateMaterial;
  2257. private _pickedPointObserver;
  2258. /**
  2259. * Gets or sets text for the button
  2260. */
  2261. text: string;
  2262. /**
  2263. * Gets or sets the image url for the button
  2264. */
  2265. imageUrl: string;
  2266. /**
  2267. * Gets the back material used by this button
  2268. */
  2269. readonly backMaterial: FluentMaterial;
  2270. /**
  2271. * Gets the front material used by this button
  2272. */
  2273. readonly frontMaterial: FluentMaterial;
  2274. /**
  2275. * Gets the plate material used by this button
  2276. */
  2277. readonly plateMaterial: StandardMaterial;
  2278. /**
  2279. * Gets a boolean indicating if this button shares its material with other HolographicButtons
  2280. */
  2281. readonly shareMaterials: boolean;
  2282. /**
  2283. * Creates a new button
  2284. * @param name defines the control name
  2285. */
  2286. constructor(name?: string, shareMaterials?: boolean);
  2287. protected _getTypeName(): string;
  2288. private _rebuildContent();
  2289. protected _createNode(scene: Scene): TransformNode;
  2290. protected _applyFacade(facadeTexture: AdvancedDynamicTexture): void;
  2291. private _createBackMaterial(mesh);
  2292. private _createFrontMaterial(mesh);
  2293. private _createPlateMaterial(mesh);
  2294. protected _affectMaterial(mesh: Mesh): void;
  2295. /**
  2296. * Releases all associated resources
  2297. */
  2298. dispose(): void;
  2299. }
  2300. }
  2301. declare module BABYLON.GUI {
  2302. /**
  2303. * Class used to create a stack panel in 3D on XY plane
  2304. */
  2305. class StackPanel3D extends Container3D {
  2306. private _isVertical;
  2307. /**
  2308. * Gets or sets a boolean indicating if the stack panel is vertical or horizontal (horizontal by default)
  2309. */
  2310. isVertical: boolean;
  2311. /**
  2312. * Gets or sets the distance between elements
  2313. */
  2314. margin: number;
  2315. /**
  2316. * Creates new StackPanel
  2317. * @param isVertical
  2318. */
  2319. constructor(isVertical?: boolean);
  2320. protected _arrangeChildren(): void;
  2321. }
  2322. }
  2323. declare module BABYLON.GUI {
  2324. /**
  2325. * Class used to create a conainter panel deployed on the surface of a sphere
  2326. */
  2327. class SpherePanel extends Container3D {
  2328. private _radius;
  2329. private _columns;
  2330. private _rows;
  2331. private _rowThenColum;
  2332. private _orientation;
  2333. /**
  2334. * Gets or sets the distance between elements
  2335. */
  2336. margin: number;
  2337. /**
  2338. * Gets or sets the orientation to apply to all controls (BABYLON.Container3D.FaceOriginReversedOrientation by default)
  2339. * | Value | Type | Description |
  2340. * | ----- | ----------------------------------- | ----------- |
  2341. * | 0 | UNSET_ORIENTATION | Control rotation will remain unchanged |
  2342. * | 1 | FACEORIGIN_ORIENTATION | Control will rotate to make it look at sphere central axis |
  2343. * | 2 | FACEORIGINREVERSED_ORIENTATION | Control will rotate to make it look back at sphere central axis |
  2344. * | 3 | FACEFORWARD_ORIENTATION | Control will rotate to look at z axis (0, 0, 1) |
  2345. * | 4 | FACEFORWARDREVERSED_ORIENTATION | Control will rotate to look at negative z axis (0, 0, -1) |
  2346. */
  2347. orientation: number;
  2348. /**
  2349. * Gets or sets the radius of the sphere where to project controls (5 by default)
  2350. */
  2351. radius: float;
  2352. /**
  2353. * Gets or sets the number of columns requested (10 by default).
  2354. * The panel will automatically compute the number of rows based on number of child controls.
  2355. */
  2356. columns: int;
  2357. /**
  2358. * Gets or sets a the number of rows requested.
  2359. * The panel will automatically compute the number of columns based on number of child controls.
  2360. */
  2361. rows: int;
  2362. /**
  2363. * Creates new SpherePanel
  2364. */
  2365. constructor();
  2366. protected _arrangeChildren(): void;
  2367. private _sphericalMapping(source);
  2368. }
  2369. }