babylon.gui.d.ts 165 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064
  1. declare module BABYLON.GUI {
  2. /**
  3. * Class used to specific a value and its associated unit
  4. */
  5. export class ValueAndUnit {
  6. /** defines the unit to store */
  7. unit: number;
  8. /** defines a boolean indicating if the value can be negative */
  9. negativeValueAllowed: boolean;
  10. private _value;
  11. private _originalUnit;
  12. /**
  13. * Gets or sets a value indicating that this value will not scale accordingly with adaptive scaling property
  14. * @see http://doc.babylonjs.com/how_to/gui#adaptive-scaling
  15. */
  16. ignoreAdaptiveScaling: boolean;
  17. /**
  18. * Creates a new ValueAndUnit
  19. * @param value defines the value to store
  20. * @param unit defines the unit to store
  21. * @param negativeValueAllowed defines a boolean indicating if the value can be negative
  22. */
  23. constructor(value: number,
  24. /** defines the unit to store */
  25. unit?: number,
  26. /** defines a boolean indicating if the value can be negative */
  27. negativeValueAllowed?: boolean);
  28. /** Gets a boolean indicating if the value is a percentage */
  29. get isPercentage(): boolean;
  30. /** Gets a boolean indicating if the value is store as pixel */
  31. get isPixel(): boolean;
  32. /** Gets direct internal value */
  33. get internalValue(): number;
  34. /**
  35. * Gets value as pixel
  36. * @param host defines the root host
  37. * @param refValue defines the reference value for percentages
  38. * @returns the value as pixel
  39. */
  40. getValueInPixel(host: AdvancedDynamicTexture, refValue: number): number;
  41. /**
  42. * Update the current value and unit. This should be done cautiously as the GUi won't be marked as dirty with this function.
  43. * @param value defines the value to store
  44. * @param unit defines the unit to store
  45. * @returns the current ValueAndUnit
  46. */
  47. updateInPlace(value: number, unit?: number): ValueAndUnit;
  48. /**
  49. * Gets the value accordingly to its unit
  50. * @param host defines the root host
  51. * @returns the value
  52. */
  53. getValue(host: AdvancedDynamicTexture): number;
  54. /**
  55. * Gets a string representation of the value
  56. * @param host defines the root host
  57. * @param decimals defines an optional number of decimals to display
  58. * @returns a string
  59. */
  60. toString(host: AdvancedDynamicTexture, decimals?: number): string;
  61. /**
  62. * Store a value parsed from a string
  63. * @param source defines the source string
  64. * @returns true if the value was successfully parsed
  65. */
  66. fromString(source: string | number): boolean;
  67. private static _Regex;
  68. private static _UNITMODE_PERCENTAGE;
  69. private static _UNITMODE_PIXEL;
  70. /** UNITMODE_PERCENTAGE */
  71. static get UNITMODE_PERCENTAGE(): number;
  72. /** UNITMODE_PIXEL */
  73. static get UNITMODE_PIXEL(): number;
  74. }
  75. }
  76. declare module BABYLON.GUI {
  77. /**
  78. * Define a style used by control to automatically setup properties based on a template.
  79. * Only support font related properties so far
  80. */
  81. export class Style implements BABYLON.IDisposable {
  82. private _fontFamily;
  83. private _fontStyle;
  84. private _fontWeight;
  85. /** @hidden */
  86. _host: AdvancedDynamicTexture;
  87. /** @hidden */
  88. _fontSize: ValueAndUnit;
  89. /**
  90. * BABYLON.Observable raised when the style values are changed
  91. */
  92. onChangedObservable: BABYLON.Observable<Style>;
  93. /**
  94. * Creates a new style object
  95. * @param host defines the AdvancedDynamicTexture which hosts this style
  96. */
  97. constructor(host: AdvancedDynamicTexture);
  98. /**
  99. * Gets or sets the font size
  100. */
  101. get fontSize(): string | number;
  102. set fontSize(value: string | number);
  103. /**
  104. * Gets or sets the font family
  105. */
  106. get fontFamily(): string;
  107. set fontFamily(value: string);
  108. /**
  109. * Gets or sets the font style
  110. */
  111. get fontStyle(): string;
  112. set fontStyle(value: string);
  113. /** Gets or sets font weight */
  114. get fontWeight(): string;
  115. set fontWeight(value: string);
  116. /** Dispose all associated resources */
  117. dispose(): void;
  118. }
  119. }
  120. declare module BABYLON.GUI {
  121. /**
  122. * Class used to transport BABYLON.Vector2 information for pointer events
  123. */
  124. export class Vector2WithInfo extends BABYLON.Vector2 {
  125. /** defines the current mouse button index */
  126. buttonIndex: number;
  127. /**
  128. * Creates a new Vector2WithInfo
  129. * @param source defines the vector2 data to transport
  130. * @param buttonIndex defines the current mouse button index
  131. */
  132. constructor(source: BABYLON.Vector2,
  133. /** defines the current mouse button index */
  134. buttonIndex?: number);
  135. }
  136. /** Class used to provide 2D matrix features */
  137. export class Matrix2D {
  138. /** Gets the internal array of 6 floats used to store matrix data */
  139. m: Float32Array;
  140. /**
  141. * Creates a new matrix
  142. * @param m00 defines value for (0, 0)
  143. * @param m01 defines value for (0, 1)
  144. * @param m10 defines value for (1, 0)
  145. * @param m11 defines value for (1, 1)
  146. * @param m20 defines value for (2, 0)
  147. * @param m21 defines value for (2, 1)
  148. */
  149. constructor(m00: number, m01: number, m10: number, m11: number, m20: number, m21: number);
  150. /**
  151. * Fills the matrix from direct values
  152. * @param m00 defines value for (0, 0)
  153. * @param m01 defines value for (0, 1)
  154. * @param m10 defines value for (1, 0)
  155. * @param m11 defines value for (1, 1)
  156. * @param m20 defines value for (2, 0)
  157. * @param m21 defines value for (2, 1)
  158. * @returns the current modified matrix
  159. */
  160. fromValues(m00: number, m01: number, m10: number, m11: number, m20: number, m21: number): Matrix2D;
  161. /**
  162. * Gets matrix determinant
  163. * @returns the determinant
  164. */
  165. determinant(): number;
  166. /**
  167. * Inverses the matrix and stores it in a target matrix
  168. * @param result defines the target matrix
  169. * @returns the current matrix
  170. */
  171. invertToRef(result: Matrix2D): Matrix2D;
  172. /**
  173. * Multiplies the current matrix with another one
  174. * @param other defines the second operand
  175. * @param result defines the target matrix
  176. * @returns the current matrix
  177. */
  178. multiplyToRef(other: Matrix2D, result: Matrix2D): Matrix2D;
  179. /**
  180. * Applies the current matrix to a set of 2 floats and stores the result in a vector2
  181. * @param x defines the x coordinate to transform
  182. * @param y defines the x coordinate to transform
  183. * @param result defines the target vector2
  184. * @returns the current matrix
  185. */
  186. transformCoordinates(x: number, y: number, result: BABYLON.Vector2): Matrix2D;
  187. /**
  188. * Creates an identity matrix
  189. * @returns a new matrix
  190. */
  191. static Identity(): Matrix2D;
  192. /**
  193. * Creates a translation matrix and stores it in a target matrix
  194. * @param x defines the x coordinate of the translation
  195. * @param y defines the y coordinate of the translation
  196. * @param result defines the target matrix
  197. */
  198. static TranslationToRef(x: number, y: number, result: Matrix2D): void;
  199. /**
  200. * Creates a scaling matrix and stores it in a target matrix
  201. * @param x defines the x coordinate of the scaling
  202. * @param y defines the y coordinate of the scaling
  203. * @param result defines the target matrix
  204. */
  205. static ScalingToRef(x: number, y: number, result: Matrix2D): void;
  206. /**
  207. * Creates a rotation matrix and stores it in a target matrix
  208. * @param angle defines the rotation angle
  209. * @param result defines the target matrix
  210. */
  211. static RotationToRef(angle: number, result: Matrix2D): void;
  212. private static _TempPreTranslationMatrix;
  213. private static _TempPostTranslationMatrix;
  214. private static _TempRotationMatrix;
  215. private static _TempScalingMatrix;
  216. private static _TempCompose0;
  217. private static _TempCompose1;
  218. private static _TempCompose2;
  219. /**
  220. * Composes a matrix from translation, rotation, scaling and parent matrix and stores it in a target matrix
  221. * @param tx defines the x coordinate of the translation
  222. * @param ty defines the y coordinate of the translation
  223. * @param angle defines the rotation angle
  224. * @param scaleX defines the x coordinate of the scaling
  225. * @param scaleY defines the y coordinate of the scaling
  226. * @param parentMatrix defines the parent matrix to multiply by (can be null)
  227. * @param result defines the target matrix
  228. */
  229. static ComposeToRef(tx: number, ty: number, angle: number, scaleX: number, scaleY: number, parentMatrix: BABYLON.Nullable<Matrix2D>, result: Matrix2D): void;
  230. }
  231. }
  232. declare module BABYLON.GUI {
  233. /**
  234. * Class used to store 2D control sizes
  235. */
  236. export class Measure {
  237. /** defines left coordinate */
  238. left: number;
  239. /** defines top coordinate */
  240. top: number;
  241. /** defines width dimension */
  242. width: number;
  243. /** defines height dimension */
  244. height: number;
  245. /**
  246. * Creates a new measure
  247. * @param left defines left coordinate
  248. * @param top defines top coordinate
  249. * @param width defines width dimension
  250. * @param height defines height dimension
  251. */
  252. constructor(
  253. /** defines left coordinate */
  254. left: number,
  255. /** defines top coordinate */
  256. top: number,
  257. /** defines width dimension */
  258. width: number,
  259. /** defines height dimension */
  260. height: number);
  261. /**
  262. * Copy from another measure
  263. * @param other defines the other measure to copy from
  264. */
  265. copyFrom(other: Measure): void;
  266. /**
  267. * Copy from a group of 4 floats
  268. * @param left defines left coordinate
  269. * @param top defines top coordinate
  270. * @param width defines width dimension
  271. * @param height defines height dimension
  272. */
  273. copyFromFloats(left: number, top: number, width: number, height: number): void;
  274. /**
  275. * Computes the axis aligned bounding box measure for two given measures
  276. * @param a Input measure
  277. * @param b Input measure
  278. * @param result the resulting bounding measure
  279. */
  280. static CombineToRef(a: Measure, b: Measure, result: Measure): void;
  281. /**
  282. * Computes the axis aligned bounding box of the measure after it is modified by a given transform
  283. * @param transform the matrix to transform the measure before computing the AABB
  284. * @param result the resulting AABB
  285. */
  286. transformToRef(transform: Matrix2D, result: Measure): void;
  287. /**
  288. * Check equality between this measure and another one
  289. * @param other defines the other measures
  290. * @returns true if both measures are equals
  291. */
  292. isEqualsTo(other: Measure): boolean;
  293. /**
  294. * Creates an empty measure
  295. * @returns a new measure
  296. */
  297. static Empty(): Measure;
  298. }
  299. }
  300. declare module BABYLON.GUI {
  301. /**
  302. * Interface used to define a control that can receive focus
  303. */
  304. export interface IFocusableControl {
  305. /**
  306. * Function called when the control receives the focus
  307. */
  308. onFocus(): void;
  309. /**
  310. * Function called when the control loses the focus
  311. */
  312. onBlur(): void;
  313. /**
  314. * Function called to let the control handle keyboard events
  315. * @param evt defines the current keyboard event
  316. */
  317. processKeyboard(evt: KeyboardEvent): void;
  318. /**
  319. * Function called to get the list of controls that should not steal the focus from this control
  320. * @returns an array of controls
  321. */
  322. keepsFocusWith(): BABYLON.Nullable<Control[]>;
  323. }
  324. /**
  325. * Class used to create texture to support 2D GUI elements
  326. * @see http://doc.babylonjs.com/how_to/gui
  327. */
  328. export class AdvancedDynamicTexture extends BABYLON.DynamicTexture {
  329. private _isDirty;
  330. private _renderObserver;
  331. private _resizeObserver;
  332. private _preKeyboardObserver;
  333. private _pointerMoveObserver;
  334. private _pointerObserver;
  335. private _canvasPointerOutObserver;
  336. private _background;
  337. /** @hidden */
  338. _rootContainer: Container;
  339. /** @hidden */
  340. _lastPickedControl: Control;
  341. /** @hidden */
  342. _lastControlOver: {
  343. [pointerId: number]: Control;
  344. };
  345. /** @hidden */
  346. _lastControlDown: {
  347. [pointerId: number]: Control;
  348. };
  349. /** @hidden */
  350. _capturingControl: {
  351. [pointerId: number]: Control;
  352. };
  353. /** @hidden */
  354. _shouldBlockPointer: boolean;
  355. /** @hidden */
  356. _layerToDispose: BABYLON.Nullable<BABYLON.Layer>;
  357. /** @hidden */
  358. _linkedControls: Control[];
  359. private _isFullscreen;
  360. private _fullscreenViewport;
  361. private _idealWidth;
  362. private _idealHeight;
  363. private _useSmallestIdeal;
  364. private _renderAtIdealSize;
  365. private _focusedControl;
  366. private _blockNextFocusCheck;
  367. private _renderScale;
  368. private _rootElement;
  369. private _cursorChanged;
  370. /** @hidden */
  371. _numLayoutCalls: number;
  372. /** Gets the number of layout calls made the last time the ADT has been rendered */
  373. get numLayoutCalls(): number;
  374. /** @hidden */
  375. _numRenderCalls: number;
  376. /** Gets the number of render calls made the last time the ADT has been rendered */
  377. get numRenderCalls(): number;
  378. /**
  379. * Define type to string to ensure compatibility across browsers
  380. * Safari doesn't support DataTransfer constructor
  381. */
  382. private _clipboardData;
  383. /**
  384. * BABYLON.Observable event triggered each time an clipboard event is received from the rendering canvas
  385. */
  386. onClipboardObservable: BABYLON.Observable<BABYLON.ClipboardInfo>;
  387. /**
  388. * BABYLON.Observable event triggered each time a pointer down is intercepted by a control
  389. */
  390. onControlPickedObservable: BABYLON.Observable<Control>;
  391. /**
  392. * BABYLON.Observable event triggered before layout is evaluated
  393. */
  394. onBeginLayoutObservable: BABYLON.Observable<AdvancedDynamicTexture>;
  395. /**
  396. * BABYLON.Observable event triggered after the layout was evaluated
  397. */
  398. onEndLayoutObservable: BABYLON.Observable<AdvancedDynamicTexture>;
  399. /**
  400. * BABYLON.Observable event triggered before the texture is rendered
  401. */
  402. onBeginRenderObservable: BABYLON.Observable<AdvancedDynamicTexture>;
  403. /**
  404. * BABYLON.Observable event triggered after the texture was rendered
  405. */
  406. onEndRenderObservable: BABYLON.Observable<AdvancedDynamicTexture>;
  407. /**
  408. * Gets or sets a boolean defining if alpha is stored as premultiplied
  409. */
  410. premulAlpha: boolean;
  411. /**
  412. * Gets or sets a number used to scale rendering size (2 means that the texture will be twice bigger).
  413. * Useful when you want more antialiasing
  414. */
  415. get renderScale(): number;
  416. set renderScale(value: number);
  417. /** Gets or sets the background color */
  418. get background(): string;
  419. set background(value: string);
  420. /**
  421. * Gets or sets the ideal width used to design controls.
  422. * The GUI will then rescale everything accordingly
  423. * @see http://doc.babylonjs.com/how_to/gui#adaptive-scaling
  424. */
  425. get idealWidth(): number;
  426. set idealWidth(value: number);
  427. /**
  428. * Gets or sets the ideal height used to design controls.
  429. * The GUI will then rescale everything accordingly
  430. * @see http://doc.babylonjs.com/how_to/gui#adaptive-scaling
  431. */
  432. get idealHeight(): number;
  433. set idealHeight(value: number);
  434. /**
  435. * Gets or sets a boolean indicating if the smallest ideal value must be used if idealWidth and idealHeight are both set
  436. * @see http://doc.babylonjs.com/how_to/gui#adaptive-scaling
  437. */
  438. get useSmallestIdeal(): boolean;
  439. set useSmallestIdeal(value: boolean);
  440. /**
  441. * Gets or sets a boolean indicating if adaptive scaling must be used
  442. * @see http://doc.babylonjs.com/how_to/gui#adaptive-scaling
  443. */
  444. get renderAtIdealSize(): boolean;
  445. set renderAtIdealSize(value: boolean);
  446. /**
  447. * Gets the ratio used when in "ideal mode"
  448. * @see http://doc.babylonjs.com/how_to/gui#adaptive-scaling
  449. * */
  450. get idealRatio(): number;
  451. /**
  452. * Gets the underlying layer used to render the texture when in fullscreen mode
  453. */
  454. get layer(): BABYLON.Nullable<BABYLON.Layer>;
  455. /**
  456. * Gets the root container control
  457. */
  458. get rootContainer(): Container;
  459. /**
  460. * Returns an array containing the root container.
  461. * This is mostly used to let the Inspector introspects the ADT
  462. * @returns an array containing the rootContainer
  463. */
  464. getChildren(): Array<Container>;
  465. /**
  466. * Will return all controls that are inside this texture
  467. * @param directDescendantsOnly defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered
  468. * @param predicate defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
  469. * @return all child controls
  470. */
  471. getDescendants(directDescendantsOnly?: boolean, predicate?: (control: Control) => boolean): Control[];
  472. /**
  473. * Gets or sets the current focused control
  474. */
  475. get focusedControl(): BABYLON.Nullable<IFocusableControl>;
  476. set focusedControl(control: BABYLON.Nullable<IFocusableControl>);
  477. /**
  478. * Gets or sets a boolean indicating if the texture must be rendered in background or foreground when in fullscreen mode
  479. */
  480. get isForeground(): boolean;
  481. set isForeground(value: boolean);
  482. /**
  483. * Gets or set information about clipboardData
  484. */
  485. get clipboardData(): string;
  486. set clipboardData(value: string);
  487. /**
  488. * Creates a new AdvancedDynamicTexture
  489. * @param name defines the name of the texture
  490. * @param width defines the width of the texture
  491. * @param height defines the height of the texture
  492. * @param scene defines the hosting scene
  493. * @param generateMipMaps defines a boolean indicating if mipmaps must be generated (false by default)
  494. * @param samplingMode defines the texture sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  495. */
  496. constructor(name: string, width: number | undefined, height: number | undefined, scene: BABYLON.Nullable<BABYLON.Scene>, generateMipMaps?: boolean, samplingMode?: number);
  497. /**
  498. * Get the current class name of the texture useful for serialization or dynamic coding.
  499. * @returns "AdvancedDynamicTexture"
  500. */
  501. getClassName(): string;
  502. /**
  503. * Function used to execute a function on all controls
  504. * @param func defines the function to execute
  505. * @param container defines the container where controls belong. If null the root container will be used
  506. */
  507. executeOnAllControls(func: (control: Control) => void, container?: Container): void;
  508. private _useInvalidateRectOptimization;
  509. /**
  510. * Gets or sets a boolean indicating if the InvalidateRect optimization should be turned on
  511. */
  512. get useInvalidateRectOptimization(): boolean;
  513. set useInvalidateRectOptimization(value: boolean);
  514. private _invalidatedRectangle;
  515. /**
  516. * Invalidates a rectangle area on the gui texture
  517. * @param invalidMinX left most position of the rectangle to invalidate in the texture
  518. * @param invalidMinY top most position of the rectangle to invalidate in the texture
  519. * @param invalidMaxX right most position of the rectangle to invalidate in the texture
  520. * @param invalidMaxY bottom most position of the rectangle to invalidate in the texture
  521. */
  522. invalidateRect(invalidMinX: number, invalidMinY: number, invalidMaxX: number, invalidMaxY: number): void;
  523. /**
  524. * Marks the texture as dirty forcing a complete update
  525. */
  526. markAsDirty(): void;
  527. /**
  528. * Helper function used to create a new style
  529. * @returns a new style
  530. * @see http://doc.babylonjs.com/how_to/gui#styles
  531. */
  532. createStyle(): Style;
  533. /**
  534. * Adds a new control to the root container
  535. * @param control defines the control to add
  536. * @returns the current texture
  537. */
  538. addControl(control: Control): AdvancedDynamicTexture;
  539. /**
  540. * Removes a control from the root container
  541. * @param control defines the control to remove
  542. * @returns the current texture
  543. */
  544. removeControl(control: Control): AdvancedDynamicTexture;
  545. /**
  546. * Release all resources
  547. */
  548. dispose(): void;
  549. private _onResize;
  550. /** @hidden */
  551. _getGlobalViewport(scene: BABYLON.Scene): BABYLON.Viewport;
  552. /**
  553. * Get screen coordinates for a vector3
  554. * @param position defines the position to project
  555. * @param worldMatrix defines the world matrix to use
  556. * @returns the projected position
  557. */
  558. getProjectedPosition(position: BABYLON.Vector3, worldMatrix: BABYLON.Matrix): BABYLON.Vector2;
  559. private _checkUpdate;
  560. private _clearMeasure;
  561. private _render;
  562. /** @hidden */
  563. _changeCursor(cursor: string): void;
  564. /** @hidden */
  565. _registerLastControlDown(control: Control, pointerId: number): void;
  566. private _doPicking;
  567. /** @hidden */
  568. _cleanControlAfterRemovalFromList(list: {
  569. [pointerId: number]: Control;
  570. }, control: Control): void;
  571. /** @hidden */
  572. _cleanControlAfterRemoval(control: Control): void;
  573. /** Attach to all scene events required to support pointer events */
  574. attach(): void;
  575. /** @hidden */
  576. private onClipboardCopy;
  577. /** @hidden */
  578. private onClipboardCut;
  579. /** @hidden */
  580. private onClipboardPaste;
  581. /**
  582. * Register the clipboard Events onto the canvas
  583. */
  584. registerClipboardEvents(): void;
  585. /**
  586. * Unregister the clipboard Events from the canvas
  587. */
  588. unRegisterClipboardEvents(): void;
  589. /**
  590. * Connect the texture to a hosting mesh to enable interactions
  591. * @param mesh defines the mesh to attach to
  592. * @param supportPointerMove defines a boolean indicating if pointer move events must be catched as well
  593. */
  594. attachToMesh(mesh: BABYLON.AbstractMesh, supportPointerMove?: boolean): void;
  595. /**
  596. * Move the focus to a specific control
  597. * @param control defines the control which will receive the focus
  598. */
  599. moveFocusToControl(control: IFocusableControl): void;
  600. private _manageFocus;
  601. private _attachToOnPointerOut;
  602. /**
  603. * Creates a new AdvancedDynamicTexture in projected mode (ie. attached to a mesh)
  604. * @param mesh defines the mesh which will receive the texture
  605. * @param width defines the texture width (1024 by default)
  606. * @param height defines the texture height (1024 by default)
  607. * @param supportPointerMove defines a boolean indicating if the texture must capture move events (true by default)
  608. * @param onlyAlphaTesting defines a boolean indicating that alpha blending will not be used (only alpha testing) (false by default)
  609. * @returns a new AdvancedDynamicTexture
  610. */
  611. static CreateForMesh(mesh: BABYLON.AbstractMesh, width?: number, height?: number, supportPointerMove?: boolean, onlyAlphaTesting?: boolean): AdvancedDynamicTexture;
  612. /**
  613. * Creates a new AdvancedDynamicTexture in fullscreen mode.
  614. * In this mode the texture will rely on a layer for its rendering.
  615. * This allows it to be treated like any other layer.
  616. * As such, if you have a multi camera setup, you can set the layerMask on the GUI as well.
  617. * LayerMask is set through advancedTexture.layer.layerMask
  618. * @param name defines name for the texture
  619. * @param foreground defines a boolean indicating if the texture must be rendered in foreground (default is true)
  620. * @param scene defines the hsoting scene
  621. * @param sampling defines the texture sampling mode (Texture.BILINEAR_SAMPLINGMODE by default)
  622. * @returns a new AdvancedDynamicTexture
  623. */
  624. static CreateFullscreenUI(name: string, foreground?: boolean, scene?: BABYLON.Nullable<BABYLON.Scene>, sampling?: number): AdvancedDynamicTexture;
  625. }
  626. }
  627. declare module BABYLON.GUI {
  628. /**
  629. * Root class used for all 2D controls
  630. * @see http://doc.babylonjs.com/how_to/gui#controls
  631. */
  632. export class Control {
  633. /** defines the name of the control */
  634. name?: string | undefined;
  635. /**
  636. * Gets or sets a boolean indicating if alpha must be an inherited value (false by default)
  637. */
  638. static AllowAlphaInheritance: boolean;
  639. private _alpha;
  640. private _alphaSet;
  641. private _zIndex;
  642. /** @hidden */
  643. _host: AdvancedDynamicTexture;
  644. /** Gets or sets the control parent */
  645. parent: BABYLON.Nullable<Container>;
  646. /** @hidden */
  647. _currentMeasure: Measure;
  648. private _fontFamily;
  649. private _fontStyle;
  650. private _fontWeight;
  651. private _fontSize;
  652. private _font;
  653. /** @hidden */
  654. _width: ValueAndUnit;
  655. /** @hidden */
  656. _height: ValueAndUnit;
  657. /** @hidden */
  658. protected _fontOffset: {
  659. ascent: number;
  660. height: number;
  661. descent: number;
  662. };
  663. private _color;
  664. private _style;
  665. private _styleObserver;
  666. /** @hidden */
  667. protected _horizontalAlignment: number;
  668. /** @hidden */
  669. protected _verticalAlignment: number;
  670. /** @hidden */
  671. protected _isDirty: boolean;
  672. /** @hidden */
  673. protected _wasDirty: boolean;
  674. /** @hidden */
  675. _tempParentMeasure: Measure;
  676. /** @hidden */
  677. _prevCurrentMeasureTransformedIntoGlobalSpace: Measure;
  678. /** @hidden */
  679. protected _cachedParentMeasure: Measure;
  680. private _paddingLeft;
  681. private _paddingRight;
  682. private _paddingTop;
  683. private _paddingBottom;
  684. /** @hidden */
  685. _left: ValueAndUnit;
  686. /** @hidden */
  687. _top: ValueAndUnit;
  688. private _scaleX;
  689. private _scaleY;
  690. private _rotation;
  691. private _transformCenterX;
  692. private _transformCenterY;
  693. /** @hidden */
  694. _transformMatrix: Matrix2D;
  695. /** @hidden */
  696. protected _invertTransformMatrix: Matrix2D;
  697. /** @hidden */
  698. protected _transformedPosition: BABYLON.Vector2;
  699. private _isMatrixDirty;
  700. private _cachedOffsetX;
  701. private _cachedOffsetY;
  702. private _isVisible;
  703. private _isHighlighted;
  704. /** @hidden */
  705. _linkedMesh: BABYLON.Nullable<BABYLON.AbstractMesh>;
  706. private _fontSet;
  707. private _dummyVector2;
  708. private _downCount;
  709. private _enterCount;
  710. private _doNotRender;
  711. private _downPointerIds;
  712. protected _isEnabled: boolean;
  713. protected _disabledColor: string;
  714. /** @hidden */
  715. protected _rebuildLayout: boolean;
  716. /** @hidden */
  717. _customData: any;
  718. /** @hidden */
  719. _isClipped: boolean;
  720. /** @hidden */
  721. _automaticSize: boolean;
  722. /** @hidden */
  723. _tag: any;
  724. /**
  725. * Gets or sets the unique id of the node. Please note that this number will be updated when the control is added to a container
  726. */
  727. uniqueId: number;
  728. /**
  729. * Gets or sets an object used to store user defined information for the node
  730. */
  731. metadata: any;
  732. /** Gets or sets a boolean indicating if the control can be hit with pointer events */
  733. isHitTestVisible: boolean;
  734. /** Gets or sets a boolean indicating if the control can block pointer events */
  735. isPointerBlocker: boolean;
  736. /** Gets or sets a boolean indicating if the control can be focusable */
  737. isFocusInvisible: boolean;
  738. /**
  739. * Gets or sets a boolean indicating if the children are clipped to the current control bounds.
  740. * Please note that not clipping children may generate issues with adt.useInvalidateRectOptimization so it is recommended to turn this optimization off if you want to use unclipped children
  741. */
  742. clipChildren: boolean;
  743. /**
  744. * Gets or sets a boolean indicating that control content must be clipped
  745. * Please note that not clipping children may generate issues with adt.useInvalidateRectOptimization so it is recommended to turn this optimization off if you want to use unclipped children
  746. */
  747. clipContent: boolean;
  748. /**
  749. * Gets or sets a boolean indicating that the current control should cache its rendering (useful when the control does not change often)
  750. */
  751. useBitmapCache: boolean;
  752. private _cacheData;
  753. private _shadowOffsetX;
  754. /** Gets or sets a value indicating the offset to apply on X axis to render the shadow */
  755. get shadowOffsetX(): number;
  756. set shadowOffsetX(value: number);
  757. private _shadowOffsetY;
  758. /** Gets or sets a value indicating the offset to apply on Y axis to render the shadow */
  759. get shadowOffsetY(): number;
  760. set shadowOffsetY(value: number);
  761. private _shadowBlur;
  762. /** Gets or sets a value indicating the amount of blur to use to render the shadow */
  763. get shadowBlur(): number;
  764. set shadowBlur(value: number);
  765. private _shadowColor;
  766. /** Gets or sets a value indicating the color of the shadow (black by default ie. "#000") */
  767. get shadowColor(): string;
  768. set shadowColor(value: string);
  769. /** Gets or sets the cursor to use when the control is hovered */
  770. hoverCursor: string;
  771. /** @hidden */
  772. protected _linkOffsetX: ValueAndUnit;
  773. /** @hidden */
  774. protected _linkOffsetY: ValueAndUnit;
  775. /** Gets the control type name */
  776. get typeName(): string;
  777. /**
  778. * Get the current class name of the control.
  779. * @returns current class name
  780. */
  781. getClassName(): string;
  782. /**
  783. * An event triggered when the pointer move over the control.
  784. */
  785. onPointerMoveObservable: BABYLON.Observable<BABYLON.Vector2>;
  786. /**
  787. * An event triggered when the pointer move out of the control.
  788. */
  789. onPointerOutObservable: BABYLON.Observable<Control>;
  790. /**
  791. * An event triggered when the pointer taps the control
  792. */
  793. onPointerDownObservable: BABYLON.Observable<Vector2WithInfo>;
  794. /**
  795. * An event triggered when pointer up
  796. */
  797. onPointerUpObservable: BABYLON.Observable<Vector2WithInfo>;
  798. /**
  799. * An event triggered when a control is clicked on
  800. */
  801. onPointerClickObservable: BABYLON.Observable<Vector2WithInfo>;
  802. /**
  803. * An event triggered when pointer enters the control
  804. */
  805. onPointerEnterObservable: BABYLON.Observable<Control>;
  806. /**
  807. * An event triggered when the control is marked as dirty
  808. */
  809. onDirtyObservable: BABYLON.Observable<Control>;
  810. /**
  811. * An event triggered before drawing the control
  812. */
  813. onBeforeDrawObservable: BABYLON.Observable<Control>;
  814. /**
  815. * An event triggered after the control was drawn
  816. */
  817. onAfterDrawObservable: BABYLON.Observable<Control>;
  818. /**
  819. * Get the hosting AdvancedDynamicTexture
  820. */
  821. get host(): AdvancedDynamicTexture;
  822. /** Gets or set information about font offsets (used to render and align text) */
  823. get fontOffset(): {
  824. ascent: number;
  825. height: number;
  826. descent: number;
  827. };
  828. set fontOffset(offset: {
  829. ascent: number;
  830. height: number;
  831. descent: number;
  832. });
  833. /** Gets or sets alpha value for the control (1 means opaque and 0 means entirely transparent) */
  834. get alpha(): number;
  835. set alpha(value: number);
  836. /**
  837. * Gets or sets a boolean indicating that we want to highlight the control (mostly for debugging purpose)
  838. */
  839. get isHighlighted(): boolean;
  840. set isHighlighted(value: boolean);
  841. /** Gets or sets a value indicating the scale factor on X axis (1 by default)
  842. * @see http://doc.babylonjs.com/how_to/gui#rotation-and-scaling
  843. */
  844. get scaleX(): number;
  845. set scaleX(value: number);
  846. /** Gets or sets a value indicating the scale factor on Y axis (1 by default)
  847. * @see http://doc.babylonjs.com/how_to/gui#rotation-and-scaling
  848. */
  849. get scaleY(): number;
  850. set scaleY(value: number);
  851. /** Gets or sets the rotation angle (0 by default)
  852. * @see http://doc.babylonjs.com/how_to/gui#rotation-and-scaling
  853. */
  854. get rotation(): number;
  855. set rotation(value: number);
  856. /** Gets or sets the transformation center on Y axis (0 by default)
  857. * @see http://doc.babylonjs.com/how_to/gui#rotation-and-scaling
  858. */
  859. get transformCenterY(): number;
  860. set transformCenterY(value: number);
  861. /** Gets or sets the transformation center on X axis (0 by default)
  862. * @see http://doc.babylonjs.com/how_to/gui#rotation-and-scaling
  863. */
  864. get transformCenterX(): number;
  865. set transformCenterX(value: number);
  866. /**
  867. * Gets or sets the horizontal alignment
  868. * @see http://doc.babylonjs.com/how_to/gui#alignments
  869. */
  870. get horizontalAlignment(): number;
  871. set horizontalAlignment(value: number);
  872. /**
  873. * Gets or sets the vertical alignment
  874. * @see http://doc.babylonjs.com/how_to/gui#alignments
  875. */
  876. get verticalAlignment(): number;
  877. set verticalAlignment(value: number);
  878. /**
  879. * Gets or sets control width
  880. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  881. */
  882. get width(): string | number;
  883. set width(value: string | number);
  884. /**
  885. * Gets or sets the control width in pixel
  886. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  887. */
  888. get widthInPixels(): number;
  889. set widthInPixels(value: number);
  890. /**
  891. * Gets or sets control height
  892. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  893. */
  894. get height(): string | number;
  895. set height(value: string | number);
  896. /**
  897. * Gets or sets control height in pixel
  898. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  899. */
  900. get heightInPixels(): number;
  901. set heightInPixels(value: number);
  902. /** Gets or set font family */
  903. get fontFamily(): string;
  904. set fontFamily(value: string);
  905. /** Gets or sets font style */
  906. get fontStyle(): string;
  907. set fontStyle(value: string);
  908. /** Gets or sets font weight */
  909. get fontWeight(): string;
  910. set fontWeight(value: string);
  911. /**
  912. * Gets or sets style
  913. * @see http://doc.babylonjs.com/how_to/gui#styles
  914. */
  915. get style(): BABYLON.Nullable<Style>;
  916. set style(value: BABYLON.Nullable<Style>);
  917. /** @hidden */
  918. get _isFontSizeInPercentage(): boolean;
  919. /** Gets or sets font size in pixels */
  920. get fontSizeInPixels(): number;
  921. set fontSizeInPixels(value: number);
  922. /** Gets or sets font size */
  923. get fontSize(): string | number;
  924. set fontSize(value: string | number);
  925. /** Gets or sets foreground color */
  926. get color(): string;
  927. set color(value: string);
  928. /** Gets or sets z index which is used to reorder controls on the z axis */
  929. get zIndex(): number;
  930. set zIndex(value: number);
  931. /** Gets or sets a boolean indicating if the control can be rendered */
  932. get notRenderable(): boolean;
  933. set notRenderable(value: boolean);
  934. /** Gets or sets a boolean indicating if the control is visible */
  935. get isVisible(): boolean;
  936. set isVisible(value: boolean);
  937. /** Gets a boolean indicating that the control needs to update its rendering */
  938. get isDirty(): boolean;
  939. /**
  940. * Gets the current linked mesh (or null if none)
  941. */
  942. get linkedMesh(): BABYLON.Nullable<BABYLON.AbstractMesh>;
  943. /**
  944. * Gets or sets a value indicating the padding to use on the left of the control
  945. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  946. */
  947. get paddingLeft(): string | number;
  948. set paddingLeft(value: string | number);
  949. /**
  950. * Gets or sets a value indicating the padding in pixels to use on the left of the control
  951. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  952. */
  953. get paddingLeftInPixels(): number;
  954. set paddingLeftInPixels(value: number);
  955. /**
  956. * Gets or sets a value indicating the padding to use on the right of the control
  957. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  958. */
  959. get paddingRight(): string | number;
  960. set paddingRight(value: string | number);
  961. /**
  962. * Gets or sets a value indicating the padding in pixels to use on the right of the control
  963. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  964. */
  965. get paddingRightInPixels(): number;
  966. set paddingRightInPixels(value: number);
  967. /**
  968. * Gets or sets a value indicating the padding to use on the top of the control
  969. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  970. */
  971. get paddingTop(): string | number;
  972. set paddingTop(value: string | number);
  973. /**
  974. * Gets or sets a value indicating the padding in pixels to use on the top of the control
  975. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  976. */
  977. get paddingTopInPixels(): number;
  978. set paddingTopInPixels(value: number);
  979. /**
  980. * Gets or sets a value indicating the padding to use on the bottom of the control
  981. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  982. */
  983. get paddingBottom(): string | number;
  984. set paddingBottom(value: string | number);
  985. /**
  986. * Gets or sets a value indicating the padding in pixels to use on the bottom of the control
  987. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  988. */
  989. get paddingBottomInPixels(): number;
  990. set paddingBottomInPixels(value: number);
  991. /**
  992. * Gets or sets a value indicating the left coordinate of the control
  993. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  994. */
  995. get left(): string | number;
  996. set left(value: string | number);
  997. /**
  998. * Gets or sets a value indicating the left coordinate in pixels of the control
  999. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  1000. */
  1001. get leftInPixels(): number;
  1002. set leftInPixels(value: number);
  1003. /**
  1004. * Gets or sets a value indicating the top coordinate of the control
  1005. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  1006. */
  1007. get top(): string | number;
  1008. set top(value: string | number);
  1009. /**
  1010. * Gets or sets a value indicating the top coordinate in pixels of the control
  1011. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  1012. */
  1013. get topInPixels(): number;
  1014. set topInPixels(value: number);
  1015. /**
  1016. * Gets or sets a value indicating the offset on X axis to the linked mesh
  1017. * @see http://doc.babylonjs.com/how_to/gui#tracking-positions
  1018. */
  1019. get linkOffsetX(): string | number;
  1020. set linkOffsetX(value: string | number);
  1021. /**
  1022. * Gets or sets a value indicating the offset in pixels on X axis to the linked mesh
  1023. * @see http://doc.babylonjs.com/how_to/gui#tracking-positions
  1024. */
  1025. get linkOffsetXInPixels(): number;
  1026. set linkOffsetXInPixels(value: number);
  1027. /**
  1028. * Gets or sets a value indicating the offset on Y axis to the linked mesh
  1029. * @see http://doc.babylonjs.com/how_to/gui#tracking-positions
  1030. */
  1031. get linkOffsetY(): string | number;
  1032. set linkOffsetY(value: string | number);
  1033. /**
  1034. * Gets or sets a value indicating the offset in pixels on Y axis to the linked mesh
  1035. * @see http://doc.babylonjs.com/how_to/gui#tracking-positions
  1036. */
  1037. get linkOffsetYInPixels(): number;
  1038. set linkOffsetYInPixels(value: number);
  1039. /** Gets the center coordinate on X axis */
  1040. get centerX(): number;
  1041. /** Gets the center coordinate on Y axis */
  1042. get centerY(): number;
  1043. /** Gets or sets if control is Enabled*/
  1044. get isEnabled(): boolean;
  1045. set isEnabled(value: boolean);
  1046. /** Gets or sets background color of control if it's disabled*/
  1047. get disabledColor(): string;
  1048. set disabledColor(value: string);
  1049. /**
  1050. * Creates a new control
  1051. * @param name defines the name of the control
  1052. */
  1053. constructor(
  1054. /** defines the name of the control */
  1055. name?: string | undefined);
  1056. /** @hidden */
  1057. protected _getTypeName(): string;
  1058. /**
  1059. * Gets the first ascendant in the hierarchy of the given type
  1060. * @param className defines the required type
  1061. * @returns the ascendant or null if not found
  1062. */
  1063. getAscendantOfClass(className: string): BABYLON.Nullable<Control>;
  1064. /** @hidden */
  1065. _resetFontCache(): void;
  1066. /**
  1067. * Determines if a container is an ascendant of the current control
  1068. * @param container defines the container to look for
  1069. * @returns true if the container is one of the ascendant of the control
  1070. */
  1071. isAscendant(container: Control): boolean;
  1072. /**
  1073. * Gets coordinates in local control space
  1074. * @param globalCoordinates defines the coordinates to transform
  1075. * @returns the new coordinates in local space
  1076. */
  1077. getLocalCoordinates(globalCoordinates: BABYLON.Vector2): BABYLON.Vector2;
  1078. /**
  1079. * Gets coordinates in local control space
  1080. * @param globalCoordinates defines the coordinates to transform
  1081. * @param result defines the target vector2 where to store the result
  1082. * @returns the current control
  1083. */
  1084. getLocalCoordinatesToRef(globalCoordinates: BABYLON.Vector2, result: BABYLON.Vector2): Control;
  1085. /**
  1086. * Gets coordinates in parent local control space
  1087. * @param globalCoordinates defines the coordinates to transform
  1088. * @returns the new coordinates in parent local space
  1089. */
  1090. getParentLocalCoordinates(globalCoordinates: BABYLON.Vector2): BABYLON.Vector2;
  1091. /**
  1092. * Move the current control to a vector3 position projected onto the screen.
  1093. * @param position defines the target position
  1094. * @param scene defines the hosting scene
  1095. */
  1096. moveToVector3(position: BABYLON.Vector3, scene: BABYLON.Scene): void;
  1097. /**
  1098. * Will store all controls that have this control as ascendant in a given array
  1099. * @param results defines the array where to store the descendants
  1100. * @param directDescendantsOnly defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered
  1101. * @param predicate defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
  1102. */
  1103. getDescendantsToRef(results: Control[], directDescendantsOnly?: boolean, predicate?: (control: Control) => boolean): void;
  1104. /**
  1105. * Will return all controls that have this control as ascendant
  1106. * @param directDescendantsOnly defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered
  1107. * @param predicate defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
  1108. * @return all child controls
  1109. */
  1110. getDescendants(directDescendantsOnly?: boolean, predicate?: (control: Control) => boolean): Control[];
  1111. /**
  1112. * Link current control with a target mesh
  1113. * @param mesh defines the mesh to link with
  1114. * @see http://doc.babylonjs.com/how_to/gui#tracking-positions
  1115. */
  1116. linkWithMesh(mesh: BABYLON.Nullable<BABYLON.AbstractMesh>): void;
  1117. /** @hidden */
  1118. _moveToProjectedPosition(projectedPosition: BABYLON.Vector3): void;
  1119. /** @hidden */
  1120. _offsetLeft(offset: number): void;
  1121. /** @hidden */
  1122. _offsetTop(offset: number): void;
  1123. /** @hidden */
  1124. _markMatrixAsDirty(): void;
  1125. /** @hidden */
  1126. _flagDescendantsAsMatrixDirty(): void;
  1127. /** @hidden */
  1128. _intersectsRect(rect: Measure): boolean;
  1129. /** @hidden */
  1130. protected invalidateRect(): void;
  1131. /** @hidden */
  1132. _markAsDirty(force?: boolean): void;
  1133. /** @hidden */
  1134. _markAllAsDirty(): void;
  1135. /** @hidden */
  1136. _link(host: AdvancedDynamicTexture): void;
  1137. /** @hidden */
  1138. protected _transform(context?: CanvasRenderingContext2D): void;
  1139. /** @hidden */
  1140. _renderHighlight(context: CanvasRenderingContext2D): void;
  1141. /** @hidden */
  1142. _renderHighlightSpecific(context: CanvasRenderingContext2D): void;
  1143. /** @hidden */
  1144. protected _applyStates(context: CanvasRenderingContext2D): void;
  1145. /** @hidden */
  1146. _layout(parentMeasure: Measure, context: CanvasRenderingContext2D): boolean;
  1147. /** @hidden */
  1148. protected _processMeasures(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  1149. protected _evaluateClippingState(parentMeasure: Measure): void;
  1150. /** @hidden */
  1151. _measure(): void;
  1152. /** @hidden */
  1153. protected _computeAlignment(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  1154. /** @hidden */
  1155. protected _preMeasure(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  1156. /** @hidden */
  1157. protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  1158. /** @hidden */
  1159. protected _clipForChildren(context: CanvasRenderingContext2D): void;
  1160. private static _ClipMeasure;
  1161. private _tmpMeasureA;
  1162. private _clip;
  1163. /** @hidden */
  1164. _render(context: CanvasRenderingContext2D, invalidatedRectangle?: BABYLON.Nullable<Measure>): boolean;
  1165. /** @hidden */
  1166. _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: BABYLON.Nullable<Measure>): void;
  1167. /**
  1168. * Tests if a given coordinates belong to the current control
  1169. * @param x defines x coordinate to test
  1170. * @param y defines y coordinate to test
  1171. * @returns true if the coordinates are inside the control
  1172. */
  1173. contains(x: number, y: number): boolean;
  1174. /** @hidden */
  1175. _processPicking(x: number, y: number, type: number, pointerId: number, buttonIndex: number): boolean;
  1176. /** @hidden */
  1177. _onPointerMove(target: Control, coordinates: BABYLON.Vector2, pointerId: number): void;
  1178. /** @hidden */
  1179. _onPointerEnter(target: Control): boolean;
  1180. /** @hidden */
  1181. _onPointerOut(target: Control, force?: boolean): void;
  1182. /** @hidden */
  1183. _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number): boolean;
  1184. /** @hidden */
  1185. _onPointerUp(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean): void;
  1186. /** @hidden */
  1187. _forcePointerUp(pointerId?: BABYLON.Nullable<number>): void;
  1188. /** @hidden */
  1189. _processObservables(type: number, x: number, y: number, pointerId: number, buttonIndex: number): boolean;
  1190. private _prepareFont;
  1191. /** Releases associated resources */
  1192. dispose(): void;
  1193. private static _HORIZONTAL_ALIGNMENT_LEFT;
  1194. private static _HORIZONTAL_ALIGNMENT_RIGHT;
  1195. private static _HORIZONTAL_ALIGNMENT_CENTER;
  1196. private static _VERTICAL_ALIGNMENT_TOP;
  1197. private static _VERTICAL_ALIGNMENT_BOTTOM;
  1198. private static _VERTICAL_ALIGNMENT_CENTER;
  1199. /** HORIZONTAL_ALIGNMENT_LEFT */
  1200. static get HORIZONTAL_ALIGNMENT_LEFT(): number;
  1201. /** HORIZONTAL_ALIGNMENT_RIGHT */
  1202. static get HORIZONTAL_ALIGNMENT_RIGHT(): number;
  1203. /** HORIZONTAL_ALIGNMENT_CENTER */
  1204. static get HORIZONTAL_ALIGNMENT_CENTER(): number;
  1205. /** VERTICAL_ALIGNMENT_TOP */
  1206. static get VERTICAL_ALIGNMENT_TOP(): number;
  1207. /** VERTICAL_ALIGNMENT_BOTTOM */
  1208. static get VERTICAL_ALIGNMENT_BOTTOM(): number;
  1209. /** VERTICAL_ALIGNMENT_CENTER */
  1210. static get VERTICAL_ALIGNMENT_CENTER(): number;
  1211. private static _FontHeightSizes;
  1212. /** @hidden */
  1213. static _GetFontOffset(font: string): {
  1214. ascent: number;
  1215. height: number;
  1216. descent: number;
  1217. };
  1218. /**
  1219. * Creates a stack panel that can be used to render headers
  1220. * @param control defines the control to associate with the header
  1221. * @param text defines the text of the header
  1222. * @param size defines the size of the header
  1223. * @param options defines options used to configure the header
  1224. * @returns a new StackPanel
  1225. * @ignore
  1226. * @hidden
  1227. */
  1228. static AddHeader: (control: Control, text: string, size: string | number, options: {
  1229. isHorizontal: boolean;
  1230. controlFirst: boolean;
  1231. }) => any;
  1232. /** @hidden */
  1233. protected static drawEllipse(x: number, y: number, width: number, height: number, context: CanvasRenderingContext2D): void;
  1234. }
  1235. }
  1236. declare module BABYLON.GUI {
  1237. /**
  1238. * Root class for 2D containers
  1239. * @see http://doc.babylonjs.com/how_to/gui#containers
  1240. */
  1241. export class Container extends Control {
  1242. name?: string | undefined;
  1243. /** @hidden */
  1244. _children: Control[];
  1245. /** @hidden */
  1246. protected _measureForChildren: Measure;
  1247. /** @hidden */
  1248. protected _background: string;
  1249. /** @hidden */
  1250. protected _adaptWidthToChildren: boolean;
  1251. /** @hidden */
  1252. protected _adaptHeightToChildren: boolean;
  1253. /**
  1254. * Gets or sets a boolean indicating that layout cycle errors should be displayed on the console
  1255. */
  1256. logLayoutCycleErrors: boolean;
  1257. /**
  1258. * Gets or sets the number of layout cycles (a change involved by a control while evaluating the layout) allowed
  1259. */
  1260. maxLayoutCycle: number;
  1261. /** Gets or sets a boolean indicating if the container should try to adapt to its children height */
  1262. get adaptHeightToChildren(): boolean;
  1263. set adaptHeightToChildren(value: boolean);
  1264. /** Gets or sets a boolean indicating if the container should try to adapt to its children width */
  1265. get adaptWidthToChildren(): boolean;
  1266. set adaptWidthToChildren(value: boolean);
  1267. /** Gets or sets background color */
  1268. get background(): string;
  1269. set background(value: string);
  1270. /** Gets the list of children */
  1271. get children(): Control[];
  1272. /**
  1273. * Creates a new Container
  1274. * @param name defines the name of the container
  1275. */
  1276. constructor(name?: string | undefined);
  1277. protected _getTypeName(): string;
  1278. _flagDescendantsAsMatrixDirty(): void;
  1279. /**
  1280. * Gets a child using its name
  1281. * @param name defines the child name to look for
  1282. * @returns the child control if found
  1283. */
  1284. getChildByName(name: string): BABYLON.Nullable<Control>;
  1285. /**
  1286. * Gets a child using its type and its name
  1287. * @param name defines the child name to look for
  1288. * @param type defines the child type to look for
  1289. * @returns the child control if found
  1290. */
  1291. getChildByType(name: string, type: string): BABYLON.Nullable<Control>;
  1292. /**
  1293. * Search for a specific control in children
  1294. * @param control defines the control to look for
  1295. * @returns true if the control is in child list
  1296. */
  1297. containsControl(control: Control): boolean;
  1298. /**
  1299. * Adds a new control to the current container
  1300. * @param control defines the control to add
  1301. * @returns the current container
  1302. */
  1303. addControl(control: BABYLON.Nullable<Control>): Container;
  1304. /**
  1305. * Removes all controls from the current container
  1306. * @returns the current container
  1307. */
  1308. clearControls(): Container;
  1309. /**
  1310. * Removes a control from the current container
  1311. * @param control defines the control to remove
  1312. * @returns the current container
  1313. */
  1314. removeControl(control: Control): Container;
  1315. /** @hidden */
  1316. _reOrderControl(control: Control): void;
  1317. /** @hidden */
  1318. _offsetLeft(offset: number): void;
  1319. /** @hidden */
  1320. _offsetTop(offset: number): void;
  1321. /** @hidden */
  1322. _markAllAsDirty(): void;
  1323. /** @hidden */
  1324. protected _localDraw(context: CanvasRenderingContext2D): void;
  1325. /** @hidden */
  1326. _link(host: AdvancedDynamicTexture): void;
  1327. /** @hidden */
  1328. protected _beforeLayout(): void;
  1329. /** @hidden */
  1330. protected _processMeasures(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  1331. /** @hidden */
  1332. _layout(parentMeasure: Measure, context: CanvasRenderingContext2D): boolean;
  1333. protected _postMeasure(): void;
  1334. /** @hidden */
  1335. _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: Measure): void;
  1336. getDescendantsToRef(results: Control[], directDescendantsOnly?: boolean, predicate?: (control: Control) => boolean): void;
  1337. /** @hidden */
  1338. _processPicking(x: number, y: number, type: number, pointerId: number, buttonIndex: number): boolean;
  1339. /** @hidden */
  1340. protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  1341. /** Releases associated resources */
  1342. dispose(): void;
  1343. }
  1344. }
  1345. declare module BABYLON.GUI {
  1346. /** Class used to create rectangle container */
  1347. export class Rectangle extends Container {
  1348. name?: string | undefined;
  1349. private _thickness;
  1350. private _cornerRadius;
  1351. /** Gets or sets border thickness */
  1352. get thickness(): number;
  1353. set thickness(value: number);
  1354. /** Gets or sets the corner radius angle */
  1355. get cornerRadius(): number;
  1356. set cornerRadius(value: number);
  1357. /**
  1358. * Creates a new Rectangle
  1359. * @param name defines the control name
  1360. */
  1361. constructor(name?: string | undefined);
  1362. protected _getTypeName(): string;
  1363. protected _localDraw(context: CanvasRenderingContext2D): void;
  1364. protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  1365. private _drawRoundedRect;
  1366. protected _clipForChildren(context: CanvasRenderingContext2D): void;
  1367. }
  1368. }
  1369. declare module BABYLON.GUI {
  1370. /**
  1371. * Enum that determines the text-wrapping mode to use.
  1372. */
  1373. export enum TextWrapping {
  1374. /**
  1375. * Clip the text when it's larger than Control.width; this is the default mode.
  1376. */
  1377. Clip = 0,
  1378. /**
  1379. * Wrap the text word-wise, i.e. try to add line-breaks at word boundary to fit within Control.width.
  1380. */
  1381. WordWrap = 1,
  1382. /**
  1383. * Ellipsize the text, i.e. shrink with trailing … when text is larger than Control.width.
  1384. */
  1385. Ellipsis = 2
  1386. }
  1387. /**
  1388. * Class used to create text block control
  1389. */
  1390. export class TextBlock extends Control {
  1391. /**
  1392. * Defines the name of the control
  1393. */
  1394. name?: string | undefined;
  1395. private _text;
  1396. private _textWrapping;
  1397. private _textHorizontalAlignment;
  1398. private _textVerticalAlignment;
  1399. private _lines;
  1400. private _resizeToFit;
  1401. private _lineSpacing;
  1402. private _outlineWidth;
  1403. private _outlineColor;
  1404. /**
  1405. * An event triggered after the text is changed
  1406. */
  1407. onTextChangedObservable: BABYLON.Observable<TextBlock>;
  1408. /**
  1409. * An event triggered after the text was broken up into lines
  1410. */
  1411. onLinesReadyObservable: BABYLON.Observable<TextBlock>;
  1412. /**
  1413. * Return the line list (you may need to use the onLinesReadyObservable to make sure the list is ready)
  1414. */
  1415. get lines(): any[];
  1416. /**
  1417. * Gets or sets an boolean indicating that the TextBlock will be resized to fit container
  1418. */
  1419. get resizeToFit(): boolean;
  1420. /**
  1421. * Gets or sets an boolean indicating that the TextBlock will be resized to fit container
  1422. */
  1423. set resizeToFit(value: boolean);
  1424. /**
  1425. * Gets or sets a boolean indicating if text must be wrapped
  1426. */
  1427. get textWrapping(): TextWrapping | boolean;
  1428. /**
  1429. * Gets or sets a boolean indicating if text must be wrapped
  1430. */
  1431. set textWrapping(value: TextWrapping | boolean);
  1432. /**
  1433. * Gets or sets text to display
  1434. */
  1435. get text(): string;
  1436. /**
  1437. * Gets or sets text to display
  1438. */
  1439. set text(value: string);
  1440. /**
  1441. * Gets or sets text horizontal alignment (BABYLON.GUI.Control.HORIZONTAL_ALIGNMENT_CENTER by default)
  1442. */
  1443. get textHorizontalAlignment(): number;
  1444. /**
  1445. * Gets or sets text horizontal alignment (BABYLON.GUI.Control.HORIZONTAL_ALIGNMENT_CENTER by default)
  1446. */
  1447. set textHorizontalAlignment(value: number);
  1448. /**
  1449. * Gets or sets text vertical alignment (BABYLON.GUI.Control.VERTICAL_ALIGNMENT_CENTER by default)
  1450. */
  1451. get textVerticalAlignment(): number;
  1452. /**
  1453. * Gets or sets text vertical alignment (BABYLON.GUI.Control.VERTICAL_ALIGNMENT_CENTER by default)
  1454. */
  1455. set textVerticalAlignment(value: number);
  1456. /**
  1457. * Gets or sets line spacing value
  1458. */
  1459. set lineSpacing(value: string | number);
  1460. /**
  1461. * Gets or sets line spacing value
  1462. */
  1463. get lineSpacing(): string | number;
  1464. /**
  1465. * Gets or sets outlineWidth of the text to display
  1466. */
  1467. get outlineWidth(): number;
  1468. /**
  1469. * Gets or sets outlineWidth of the text to display
  1470. */
  1471. set outlineWidth(value: number);
  1472. /**
  1473. * Gets or sets outlineColor of the text to display
  1474. */
  1475. get outlineColor(): string;
  1476. /**
  1477. * Gets or sets outlineColor of the text to display
  1478. */
  1479. set outlineColor(value: string);
  1480. /**
  1481. * Creates a new TextBlock object
  1482. * @param name defines the name of the control
  1483. * @param text defines the text to display (emptry string by default)
  1484. */
  1485. constructor(
  1486. /**
  1487. * Defines the name of the control
  1488. */
  1489. name?: string | undefined, text?: string);
  1490. protected _getTypeName(): string;
  1491. protected _processMeasures(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  1492. private _drawText;
  1493. /** @hidden */
  1494. _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: BABYLON.Nullable<Measure>): void;
  1495. protected _applyStates(context: CanvasRenderingContext2D): void;
  1496. protected _breakLines(refWidth: number, context: CanvasRenderingContext2D): object[];
  1497. protected _parseLine(line: string | undefined, context: CanvasRenderingContext2D): object;
  1498. protected _parseLineEllipsis(line: string | undefined, width: number, context: CanvasRenderingContext2D): object;
  1499. protected _parseLineWordWrap(line: string | undefined, width: number, context: CanvasRenderingContext2D): object[];
  1500. protected _renderLines(context: CanvasRenderingContext2D): void;
  1501. /**
  1502. * Given a width constraint applied on the text block, find the expected height
  1503. * @returns expected height
  1504. */
  1505. computeExpectedHeight(): number;
  1506. dispose(): void;
  1507. }
  1508. }
  1509. declare module BABYLON.GUI {
  1510. /**
  1511. * Class used to create 2D images
  1512. */
  1513. export class Image extends Control {
  1514. name?: string | undefined;
  1515. private _workingCanvas;
  1516. private _domImage;
  1517. private _imageWidth;
  1518. private _imageHeight;
  1519. private _loaded;
  1520. private _stretch;
  1521. private _source;
  1522. private _autoScale;
  1523. private _sourceLeft;
  1524. private _sourceTop;
  1525. private _sourceWidth;
  1526. private _sourceHeight;
  1527. private _svgAttributesComputationCompleted;
  1528. private _isSVG;
  1529. private _cellWidth;
  1530. private _cellHeight;
  1531. private _cellId;
  1532. private _populateNinePatchSlicesFromImage;
  1533. private _sliceLeft;
  1534. private _sliceRight;
  1535. private _sliceTop;
  1536. private _sliceBottom;
  1537. private _detectPointerOnOpaqueOnly;
  1538. /**
  1539. * BABYLON.Observable notified when the content is loaded
  1540. */
  1541. onImageLoadedObservable: BABYLON.Observable<Image>;
  1542. /**
  1543. * BABYLON.Observable notified when _sourceLeft, _sourceTop, _sourceWidth and _sourceHeight are computed
  1544. */
  1545. onSVGAttributesComputedObservable: BABYLON.Observable<Image>;
  1546. /**
  1547. * Gets a boolean indicating that the content is loaded
  1548. */
  1549. get isLoaded(): boolean;
  1550. /**
  1551. * Gets or sets a boolean indicating if nine patch slices (left, top, right, bottom) should be read from image data
  1552. */
  1553. get populateNinePatchSlicesFromImage(): boolean;
  1554. set populateNinePatchSlicesFromImage(value: boolean);
  1555. /**
  1556. * Gets or sets a boolean indicating if pointers should only be validated on pixels with alpha > 0.
  1557. * Beware using this as this will comsume more memory as the image has to be stored twice
  1558. */
  1559. get detectPointerOnOpaqueOnly(): boolean;
  1560. set detectPointerOnOpaqueOnly(value: boolean);
  1561. /**
  1562. * Gets or sets the left value for slicing (9-patch)
  1563. */
  1564. get sliceLeft(): number;
  1565. set sliceLeft(value: number);
  1566. /**
  1567. * Gets or sets the right value for slicing (9-patch)
  1568. */
  1569. get sliceRight(): number;
  1570. set sliceRight(value: number);
  1571. /**
  1572. * Gets or sets the top value for slicing (9-patch)
  1573. */
  1574. get sliceTop(): number;
  1575. set sliceTop(value: number);
  1576. /**
  1577. * Gets or sets the bottom value for slicing (9-patch)
  1578. */
  1579. get sliceBottom(): number;
  1580. set sliceBottom(value: number);
  1581. /**
  1582. * Gets or sets the left coordinate in the source image
  1583. */
  1584. get sourceLeft(): number;
  1585. set sourceLeft(value: number);
  1586. /**
  1587. * Gets or sets the top coordinate in the source image
  1588. */
  1589. get sourceTop(): number;
  1590. set sourceTop(value: number);
  1591. /**
  1592. * Gets or sets the width to capture in the source image
  1593. */
  1594. get sourceWidth(): number;
  1595. set sourceWidth(value: number);
  1596. /**
  1597. * Gets or sets the height to capture in the source image
  1598. */
  1599. get sourceHeight(): number;
  1600. set sourceHeight(value: number);
  1601. /** Indicates if the format of the image is SVG */
  1602. get isSVG(): boolean;
  1603. /** Gets the status of the SVG attributes computation (sourceLeft, sourceTop, sourceWidth, sourceHeight) */
  1604. get svgAttributesComputationCompleted(): boolean;
  1605. /**
  1606. * Gets or sets a boolean indicating if the image can force its container to adapt its size
  1607. * @see http://doc.babylonjs.com/how_to/gui#image
  1608. */
  1609. get autoScale(): boolean;
  1610. set autoScale(value: boolean);
  1611. /** Gets or sets the streching mode used by the image */
  1612. get stretch(): number;
  1613. set stretch(value: number);
  1614. /** @hidden */
  1615. _rotate90(n: number, preserveProperties?: boolean): Image;
  1616. private _handleRotationForSVGImage;
  1617. private _rotate90SourceProperties;
  1618. /**
  1619. * Gets or sets the internal DOM image used to render the control
  1620. */
  1621. set domImage(value: HTMLImageElement);
  1622. get domImage(): HTMLImageElement;
  1623. private _onImageLoaded;
  1624. private _extractNinePatchSliceDataFromImage;
  1625. /**
  1626. * Gets or sets image source url
  1627. */
  1628. set source(value: BABYLON.Nullable<string>);
  1629. /**
  1630. * Checks for svg document with icon id present
  1631. */
  1632. private _svgCheck;
  1633. /**
  1634. * Sets sourceLeft, sourceTop, sourceWidth, sourceHeight automatically
  1635. * given external svg file and icon id
  1636. */
  1637. private _getSVGAttribs;
  1638. /**
  1639. * Gets or sets the cell width to use when animation sheet is enabled
  1640. * @see http://doc.babylonjs.com/how_to/gui#image
  1641. */
  1642. get cellWidth(): number;
  1643. set cellWidth(value: number);
  1644. /**
  1645. * Gets or sets the cell height to use when animation sheet is enabled
  1646. * @see http://doc.babylonjs.com/how_to/gui#image
  1647. */
  1648. get cellHeight(): number;
  1649. set cellHeight(value: number);
  1650. /**
  1651. * Gets or sets the cell id to use (this will turn on the animation sheet mode)
  1652. * @see http://doc.babylonjs.com/how_to/gui#image
  1653. */
  1654. get cellId(): number;
  1655. set cellId(value: number);
  1656. /**
  1657. * Creates a new Image
  1658. * @param name defines the control name
  1659. * @param url defines the image url
  1660. */
  1661. constructor(name?: string | undefined, url?: BABYLON.Nullable<string>);
  1662. /**
  1663. * Tests if a given coordinates belong to the current control
  1664. * @param x defines x coordinate to test
  1665. * @param y defines y coordinate to test
  1666. * @returns true if the coordinates are inside the control
  1667. */
  1668. contains(x: number, y: number): boolean;
  1669. protected _getTypeName(): string;
  1670. /** Force the control to synchronize with its content */
  1671. synchronizeSizeWithContent(): void;
  1672. protected _processMeasures(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  1673. private _prepareWorkingCanvasForOpaqueDetection;
  1674. private _drawImage;
  1675. _draw(context: CanvasRenderingContext2D): void;
  1676. private _renderCornerPatch;
  1677. private _renderNinePatch;
  1678. dispose(): void;
  1679. /** STRETCH_NONE */
  1680. static readonly STRETCH_NONE: number;
  1681. /** STRETCH_FILL */
  1682. static readonly STRETCH_FILL: number;
  1683. /** STRETCH_UNIFORM */
  1684. static readonly STRETCH_UNIFORM: number;
  1685. /** STRETCH_EXTEND */
  1686. static readonly STRETCH_EXTEND: number;
  1687. /** NINE_PATCH */
  1688. static readonly STRETCH_NINE_PATCH: number;
  1689. }
  1690. }
  1691. declare module BABYLON.GUI {
  1692. /**
  1693. * Class used to create 2D buttons
  1694. */
  1695. export class Button extends Rectangle {
  1696. name?: string | undefined;
  1697. /**
  1698. * Function called to generate a pointer enter animation
  1699. */
  1700. pointerEnterAnimation: () => void;
  1701. /**
  1702. * Function called to generate a pointer out animation
  1703. */
  1704. pointerOutAnimation: () => void;
  1705. /**
  1706. * Function called to generate a pointer down animation
  1707. */
  1708. pointerDownAnimation: () => void;
  1709. /**
  1710. * Function called to generate a pointer up animation
  1711. */
  1712. pointerUpAnimation: () => void;
  1713. /**
  1714. * Gets or sets a boolean indicating that the button will let internal controls handle picking instead of doing it directly using its bounding info
  1715. */
  1716. delegatePickingToChildren: boolean;
  1717. private _image;
  1718. /**
  1719. * Returns the image part of the button (if any)
  1720. */
  1721. get image(): BABYLON.Nullable<Image>;
  1722. private _textBlock;
  1723. /**
  1724. * Returns the image part of the button (if any)
  1725. */
  1726. get textBlock(): BABYLON.Nullable<TextBlock>;
  1727. /**
  1728. * Creates a new Button
  1729. * @param name defines the name of the button
  1730. */
  1731. constructor(name?: string | undefined);
  1732. protected _getTypeName(): string;
  1733. /** @hidden */
  1734. _processPicking(x: number, y: number, type: number, pointerId: number, buttonIndex: number): boolean;
  1735. /** @hidden */
  1736. _onPointerEnter(target: Control): boolean;
  1737. /** @hidden */
  1738. _onPointerOut(target: Control, force?: boolean): void;
  1739. /** @hidden */
  1740. _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number): boolean;
  1741. /** @hidden */
  1742. _onPointerUp(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean): void;
  1743. /**
  1744. * Creates a new button made with an image and a text
  1745. * @param name defines the name of the button
  1746. * @param text defines the text of the button
  1747. * @param imageUrl defines the url of the image
  1748. * @returns a new Button
  1749. */
  1750. static CreateImageButton(name: string, text: string, imageUrl: string): Button;
  1751. /**
  1752. * Creates a new button made with an image
  1753. * @param name defines the name of the button
  1754. * @param imageUrl defines the url of the image
  1755. * @returns a new Button
  1756. */
  1757. static CreateImageOnlyButton(name: string, imageUrl: string): Button;
  1758. /**
  1759. * Creates a new button made with a text
  1760. * @param name defines the name of the button
  1761. * @param text defines the text of the button
  1762. * @returns a new Button
  1763. */
  1764. static CreateSimpleButton(name: string, text: string): Button;
  1765. /**
  1766. * Creates a new button made with an image and a centered text
  1767. * @param name defines the name of the button
  1768. * @param text defines the text of the button
  1769. * @param imageUrl defines the url of the image
  1770. * @returns a new Button
  1771. */
  1772. static CreateImageWithCenterTextButton(name: string, text: string, imageUrl: string): Button;
  1773. }
  1774. }
  1775. declare module BABYLON.GUI {
  1776. /**
  1777. * Class used to create a 2D stack panel container
  1778. */
  1779. export class StackPanel extends Container {
  1780. name?: string | undefined;
  1781. private _isVertical;
  1782. private _manualWidth;
  1783. private _manualHeight;
  1784. private _doNotTrackManualChanges;
  1785. /**
  1786. * Gets or sets a boolean indicating that layou warnings should be ignored
  1787. */
  1788. ignoreLayoutWarnings: boolean;
  1789. /** Gets or sets a boolean indicating if the stack panel is vertical or horizontal*/
  1790. get isVertical(): boolean;
  1791. set isVertical(value: boolean);
  1792. /**
  1793. * Gets or sets panel width.
  1794. * This value should not be set when in horizontal mode as it will be computed automatically
  1795. */
  1796. set width(value: string | number);
  1797. get width(): string | number;
  1798. /**
  1799. * Gets or sets panel height.
  1800. * This value should not be set when in vertical mode as it will be computed automatically
  1801. */
  1802. set height(value: string | number);
  1803. get height(): string | number;
  1804. /**
  1805. * Creates a new StackPanel
  1806. * @param name defines control name
  1807. */
  1808. constructor(name?: string | undefined);
  1809. protected _getTypeName(): string;
  1810. /** @hidden */
  1811. protected _preMeasure(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  1812. protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  1813. protected _postMeasure(): void;
  1814. }
  1815. }
  1816. declare module BABYLON.GUI {
  1817. /**
  1818. * Class used to represent a 2D checkbox
  1819. */
  1820. export class Checkbox extends Control {
  1821. name?: string | undefined;
  1822. private _isChecked;
  1823. private _background;
  1824. private _checkSizeRatio;
  1825. private _thickness;
  1826. /** Gets or sets border thickness */
  1827. get thickness(): number;
  1828. set thickness(value: number);
  1829. /**
  1830. * BABYLON.Observable raised when isChecked property changes
  1831. */
  1832. onIsCheckedChangedObservable: BABYLON.Observable<boolean>;
  1833. /** Gets or sets a value indicating the ratio between overall size and check size */
  1834. get checkSizeRatio(): number;
  1835. set checkSizeRatio(value: number);
  1836. /** Gets or sets background color */
  1837. get background(): string;
  1838. set background(value: string);
  1839. /** Gets or sets a boolean indicating if the checkbox is checked or not */
  1840. get isChecked(): boolean;
  1841. set isChecked(value: boolean);
  1842. /**
  1843. * Creates a new CheckBox
  1844. * @param name defines the control name
  1845. */
  1846. constructor(name?: string | undefined);
  1847. protected _getTypeName(): string;
  1848. /** @hidden */
  1849. _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: BABYLON.Nullable<Measure>): void;
  1850. /** @hidden */
  1851. _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number): boolean;
  1852. /**
  1853. * Utility function to easily create a checkbox with a header
  1854. * @param title defines the label to use for the header
  1855. * @param onValueChanged defines the callback to call when value changes
  1856. * @returns a StackPanel containing the checkbox and a textBlock
  1857. */
  1858. static AddCheckBoxWithHeader(title: string, onValueChanged: (value: boolean) => void): StackPanel;
  1859. }
  1860. }
  1861. declare module BABYLON.GUI {
  1862. /**
  1863. * Class used to store key control properties
  1864. */
  1865. export class KeyPropertySet {
  1866. /** Width */
  1867. width?: string;
  1868. /** Height */
  1869. height?: string;
  1870. /** Left padding */
  1871. paddingLeft?: string;
  1872. /** Right padding */
  1873. paddingRight?: string;
  1874. /** Top padding */
  1875. paddingTop?: string;
  1876. /** Bottom padding */
  1877. paddingBottom?: string;
  1878. /** Foreground color */
  1879. color?: string;
  1880. /** Background color */
  1881. background?: string;
  1882. }
  1883. /**
  1884. * Class used to create virtual keyboard
  1885. */
  1886. export class VirtualKeyboard extends StackPanel {
  1887. /** BABYLON.Observable raised when a key is pressed */
  1888. onKeyPressObservable: BABYLON.Observable<string>;
  1889. /** Gets or sets default key button width */
  1890. defaultButtonWidth: string;
  1891. /** Gets or sets default key button height */
  1892. defaultButtonHeight: string;
  1893. /** Gets or sets default key button left padding */
  1894. defaultButtonPaddingLeft: string;
  1895. /** Gets or sets default key button right padding */
  1896. defaultButtonPaddingRight: string;
  1897. /** Gets or sets default key button top padding */
  1898. defaultButtonPaddingTop: string;
  1899. /** Gets or sets default key button bottom padding */
  1900. defaultButtonPaddingBottom: string;
  1901. /** Gets or sets default key button foreground color */
  1902. defaultButtonColor: string;
  1903. /** Gets or sets default key button background color */
  1904. defaultButtonBackground: string;
  1905. /** Gets or sets shift button foreground color */
  1906. shiftButtonColor: string;
  1907. /** Gets or sets shift button thickness*/
  1908. selectedShiftThickness: number;
  1909. /** Gets shift key state */
  1910. shiftState: number;
  1911. protected _getTypeName(): string;
  1912. private _createKey;
  1913. /**
  1914. * Adds a new row of keys
  1915. * @param keys defines the list of keys to add
  1916. * @param propertySets defines the associated property sets
  1917. */
  1918. addKeysRow(keys: Array<string>, propertySets?: Array<KeyPropertySet>): void;
  1919. /**
  1920. * Set the shift key to a specific state
  1921. * @param shiftState defines the new shift state
  1922. */
  1923. applyShiftState(shiftState: number): void;
  1924. private _currentlyConnectedInputText;
  1925. private _connectedInputTexts;
  1926. private _onKeyPressObserver;
  1927. /** Gets the input text control currently attached to the keyboard */
  1928. get connectedInputText(): BABYLON.Nullable<InputText>;
  1929. /**
  1930. * Connects the keyboard with an input text control
  1931. *
  1932. * @param input defines the target control
  1933. */
  1934. connect(input: InputText): void;
  1935. /**
  1936. * Disconnects the keyboard from connected InputText controls
  1937. *
  1938. * @param input optionally defines a target control, otherwise all are disconnected
  1939. */
  1940. disconnect(input?: InputText): void;
  1941. private _removeConnectedInputObservables;
  1942. /**
  1943. * Release all resources
  1944. */
  1945. dispose(): void;
  1946. /**
  1947. * Creates a new keyboard using a default layout
  1948. *
  1949. * @param name defines control name
  1950. * @returns a new VirtualKeyboard
  1951. */
  1952. static CreateDefaultLayout(name?: string): VirtualKeyboard;
  1953. }
  1954. }
  1955. declare module BABYLON.GUI {
  1956. /**
  1957. * Class used to create input text control
  1958. */
  1959. export class InputText extends Control implements IFocusableControl {
  1960. name?: string | undefined;
  1961. private _text;
  1962. private _placeholderText;
  1963. private _background;
  1964. private _focusedBackground;
  1965. private _focusedColor;
  1966. private _placeholderColor;
  1967. private _thickness;
  1968. private _margin;
  1969. private _autoStretchWidth;
  1970. private _maxWidth;
  1971. private _isFocused;
  1972. private _blinkTimeout;
  1973. private _blinkIsEven;
  1974. private _cursorOffset;
  1975. private _scrollLeft;
  1976. private _textWidth;
  1977. private _clickedCoordinate;
  1978. private _deadKey;
  1979. private _addKey;
  1980. private _currentKey;
  1981. private _isTextHighlightOn;
  1982. private _textHighlightColor;
  1983. private _highligherOpacity;
  1984. private _highlightedText;
  1985. private _startHighlightIndex;
  1986. private _endHighlightIndex;
  1987. private _cursorIndex;
  1988. private _onFocusSelectAll;
  1989. private _isPointerDown;
  1990. private _onClipboardObserver;
  1991. private _onPointerDblTapObserver;
  1992. /** @hidden */
  1993. _connectedVirtualKeyboard: BABYLON.Nullable<VirtualKeyboard>;
  1994. /** Gets or sets a string representing the message displayed on mobile when the control gets the focus */
  1995. promptMessage: string;
  1996. /** Force disable prompt on mobile device */
  1997. disableMobilePrompt: boolean;
  1998. /** BABYLON.Observable raised when the text changes */
  1999. onTextChangedObservable: BABYLON.Observable<InputText>;
  2000. /** BABYLON.Observable raised just before an entered character is to be added */
  2001. onBeforeKeyAddObservable: BABYLON.Observable<InputText>;
  2002. /** BABYLON.Observable raised when the control gets the focus */
  2003. onFocusObservable: BABYLON.Observable<InputText>;
  2004. /** BABYLON.Observable raised when the control loses the focus */
  2005. onBlurObservable: BABYLON.Observable<InputText>;
  2006. /**Observable raised when the text is highlighted */
  2007. onTextHighlightObservable: BABYLON.Observable<InputText>;
  2008. /**Observable raised when copy event is triggered */
  2009. onTextCopyObservable: BABYLON.Observable<InputText>;
  2010. /** BABYLON.Observable raised when cut event is triggered */
  2011. onTextCutObservable: BABYLON.Observable<InputText>;
  2012. /** BABYLON.Observable raised when paste event is triggered */
  2013. onTextPasteObservable: BABYLON.Observable<InputText>;
  2014. /** BABYLON.Observable raised when a key event was processed */
  2015. onKeyboardEventProcessedObservable: BABYLON.Observable<KeyboardEvent>;
  2016. /** Gets or sets the maximum width allowed by the control */
  2017. get maxWidth(): string | number;
  2018. /** Gets the maximum width allowed by the control in pixels */
  2019. get maxWidthInPixels(): number;
  2020. set maxWidth(value: string | number);
  2021. /** Gets or sets the text highlighter transparency; default: 0.4 */
  2022. get highligherOpacity(): number;
  2023. set highligherOpacity(value: number);
  2024. /** Gets or sets a boolean indicating whether to select complete text by default on input focus */
  2025. get onFocusSelectAll(): boolean;
  2026. set onFocusSelectAll(value: boolean);
  2027. /** Gets or sets the text hightlight color */
  2028. get textHighlightColor(): string;
  2029. set textHighlightColor(value: string);
  2030. /** Gets or sets control margin */
  2031. get margin(): string;
  2032. /** Gets control margin in pixels */
  2033. get marginInPixels(): number;
  2034. set margin(value: string);
  2035. /** Gets or sets a boolean indicating if the control can auto stretch its width to adapt to the text */
  2036. get autoStretchWidth(): boolean;
  2037. set autoStretchWidth(value: boolean);
  2038. /** Gets or sets border thickness */
  2039. get thickness(): number;
  2040. set thickness(value: number);
  2041. /** Gets or sets the background color when focused */
  2042. get focusedBackground(): string;
  2043. set focusedBackground(value: string);
  2044. /** Gets or sets the background color when focused */
  2045. get focusedColor(): string;
  2046. set focusedColor(value: string);
  2047. /** Gets or sets the background color */
  2048. get background(): string;
  2049. set background(value: string);
  2050. /** Gets or sets the placeholder color */
  2051. get placeholderColor(): string;
  2052. set placeholderColor(value: string);
  2053. /** Gets or sets the text displayed when the control is empty */
  2054. get placeholderText(): string;
  2055. set placeholderText(value: string);
  2056. /** Gets or sets the dead key flag */
  2057. get deadKey(): boolean;
  2058. set deadKey(flag: boolean);
  2059. /** Gets or sets the highlight text */
  2060. get highlightedText(): string;
  2061. set highlightedText(text: string);
  2062. /** Gets or sets if the current key should be added */
  2063. get addKey(): boolean;
  2064. set addKey(flag: boolean);
  2065. /** Gets or sets the value of the current key being entered */
  2066. get currentKey(): string;
  2067. set currentKey(key: string);
  2068. /** Gets or sets the text displayed in the control */
  2069. get text(): string;
  2070. set text(value: string);
  2071. /** Gets or sets control width */
  2072. get width(): string | number;
  2073. set width(value: string | number);
  2074. /**
  2075. * Creates a new InputText
  2076. * @param name defines the control name
  2077. * @param text defines the text of the control
  2078. */
  2079. constructor(name?: string | undefined, text?: string);
  2080. /** @hidden */
  2081. onBlur(): void;
  2082. /** @hidden */
  2083. onFocus(): void;
  2084. protected _getTypeName(): string;
  2085. /**
  2086. * Function called to get the list of controls that should not steal the focus from this control
  2087. * @returns an array of controls
  2088. */
  2089. keepsFocusWith(): BABYLON.Nullable<Control[]>;
  2090. /** @hidden */
  2091. processKey(keyCode: number, key?: string, evt?: KeyboardEvent): void;
  2092. /** @hidden */
  2093. private _updateValueFromCursorIndex;
  2094. /** @hidden */
  2095. private _processDblClick;
  2096. /** @hidden */
  2097. private _selectAllText;
  2098. /**
  2099. * Handles the keyboard event
  2100. * @param evt Defines the KeyboardEvent
  2101. */
  2102. processKeyboard(evt: KeyboardEvent): void;
  2103. /** @hidden */
  2104. private _onCopyText;
  2105. /** @hidden */
  2106. private _onCutText;
  2107. /** @hidden */
  2108. private _onPasteText;
  2109. _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: BABYLON.Nullable<Measure>): void;
  2110. _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number): boolean;
  2111. _onPointerMove(target: Control, coordinates: BABYLON.Vector2, pointerId: number): void;
  2112. _onPointerUp(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean): void;
  2113. protected _beforeRenderText(text: string): string;
  2114. dispose(): void;
  2115. }
  2116. }
  2117. declare module BABYLON.GUI {
  2118. /**
  2119. * Class used to create a 2D grid container
  2120. */
  2121. export class Grid extends Container {
  2122. name?: string | undefined;
  2123. private _rowDefinitions;
  2124. private _columnDefinitions;
  2125. private _cells;
  2126. private _childControls;
  2127. /**
  2128. * Gets the number of columns
  2129. */
  2130. get columnCount(): number;
  2131. /**
  2132. * Gets the number of rows
  2133. */
  2134. get rowCount(): number;
  2135. /** Gets the list of children */
  2136. get children(): Control[];
  2137. /** Gets the list of cells (e.g. the containers) */
  2138. get cells(): {
  2139. [key: string]: Container;
  2140. };
  2141. /**
  2142. * Gets the definition of a specific row
  2143. * @param index defines the index of the row
  2144. * @returns the row definition
  2145. */
  2146. getRowDefinition(index: number): BABYLON.Nullable<ValueAndUnit>;
  2147. /**
  2148. * Gets the definition of a specific column
  2149. * @param index defines the index of the column
  2150. * @returns the column definition
  2151. */
  2152. getColumnDefinition(index: number): BABYLON.Nullable<ValueAndUnit>;
  2153. /**
  2154. * Adds a new row to the grid
  2155. * @param height defines the height of the row (either in pixel or a value between 0 and 1)
  2156. * @param isPixel defines if the height is expressed in pixel (or in percentage)
  2157. * @returns the current grid
  2158. */
  2159. addRowDefinition(height: number, isPixel?: boolean): Grid;
  2160. /**
  2161. * Adds a new column to the grid
  2162. * @param width defines the width of the column (either in pixel or a value between 0 and 1)
  2163. * @param isPixel defines if the width is expressed in pixel (or in percentage)
  2164. * @returns the current grid
  2165. */
  2166. addColumnDefinition(width: number, isPixel?: boolean): Grid;
  2167. /**
  2168. * Update a row definition
  2169. * @param index defines the index of the row to update
  2170. * @param height defines the height of the row (either in pixel or a value between 0 and 1)
  2171. * @param isPixel defines if the weight is expressed in pixel (or in percentage)
  2172. * @returns the current grid
  2173. */
  2174. setRowDefinition(index: number, height: number, isPixel?: boolean): Grid;
  2175. /**
  2176. * Update a column definition
  2177. * @param index defines the index of the column to update
  2178. * @param width defines the width of the column (either in pixel or a value between 0 and 1)
  2179. * @param isPixel defines if the width is expressed in pixel (or in percentage)
  2180. * @returns the current grid
  2181. */
  2182. setColumnDefinition(index: number, width: number, isPixel?: boolean): Grid;
  2183. /**
  2184. * Gets the list of children stored in a specific cell
  2185. * @param row defines the row to check
  2186. * @param column defines the column to check
  2187. * @returns the list of controls
  2188. */
  2189. getChildrenAt(row: number, column: number): BABYLON.Nullable<Array<Control>>;
  2190. /**
  2191. * Gets a string representing the child cell info (row x column)
  2192. * @param child defines the control to get info from
  2193. * @returns a string containing the child cell info (row x column)
  2194. */
  2195. getChildCellInfo(child: Control): string;
  2196. private _removeCell;
  2197. private _offsetCell;
  2198. /**
  2199. * Remove a column definition at specified index
  2200. * @param index defines the index of the column to remove
  2201. * @returns the current grid
  2202. */
  2203. removeColumnDefinition(index: number): Grid;
  2204. /**
  2205. * Remove a row definition at specified index
  2206. * @param index defines the index of the row to remove
  2207. * @returns the current grid
  2208. */
  2209. removeRowDefinition(index: number): Grid;
  2210. /**
  2211. * Adds a new control to the current grid
  2212. * @param control defines the control to add
  2213. * @param row defines the row where to add the control (0 by default)
  2214. * @param column defines the column where to add the control (0 by default)
  2215. * @returns the current grid
  2216. */
  2217. addControl(control: Control, row?: number, column?: number): Grid;
  2218. /**
  2219. * Removes a control from the current container
  2220. * @param control defines the control to remove
  2221. * @returns the current container
  2222. */
  2223. removeControl(control: Control): Container;
  2224. /**
  2225. * Creates a new Grid
  2226. * @param name defines control name
  2227. */
  2228. constructor(name?: string | undefined);
  2229. protected _getTypeName(): string;
  2230. protected _getGridDefinitions(definitionCallback: (lefts: number[], tops: number[], widths: number[], heights: number[]) => void): void;
  2231. protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  2232. _flagDescendantsAsMatrixDirty(): void;
  2233. _renderHighlightSpecific(context: CanvasRenderingContext2D): void;
  2234. /** Releases associated resources */
  2235. dispose(): void;
  2236. }
  2237. }
  2238. declare module BABYLON.GUI {
  2239. /** Class used to create color pickers */
  2240. export class ColorPicker extends Control {
  2241. name?: string | undefined;
  2242. private static _Epsilon;
  2243. private _colorWheelCanvas;
  2244. private _value;
  2245. private _tmpColor;
  2246. private _pointerStartedOnSquare;
  2247. private _pointerStartedOnWheel;
  2248. private _squareLeft;
  2249. private _squareTop;
  2250. private _squareSize;
  2251. private _h;
  2252. private _s;
  2253. private _v;
  2254. private _lastPointerDownID;
  2255. /**
  2256. * BABYLON.Observable raised when the value changes
  2257. */
  2258. onValueChangedObservable: BABYLON.Observable<BABYLON.Color3>;
  2259. /** Gets or sets the color of the color picker */
  2260. get value(): BABYLON.Color3;
  2261. set value(value: BABYLON.Color3);
  2262. /**
  2263. * Gets or sets control width
  2264. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  2265. */
  2266. get width(): string | number;
  2267. set width(value: string | number);
  2268. /**
  2269. * Gets or sets control height
  2270. * @see http://doc.babylonjs.com/how_to/gui#position-and-size
  2271. */
  2272. get height(): string | number;
  2273. /** Gets or sets control height */
  2274. set height(value: string | number);
  2275. /** Gets or sets control size */
  2276. get size(): string | number;
  2277. set size(value: string | number);
  2278. /**
  2279. * Creates a new ColorPicker
  2280. * @param name defines the control name
  2281. */
  2282. constructor(name?: string | undefined);
  2283. protected _getTypeName(): string;
  2284. /** @hidden */
  2285. protected _preMeasure(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  2286. private _updateSquareProps;
  2287. private _drawGradientSquare;
  2288. private _drawCircle;
  2289. private _createColorWheelCanvas;
  2290. /** @hidden */
  2291. _draw(context: CanvasRenderingContext2D): void;
  2292. private _pointerIsDown;
  2293. private _updateValueFromPointer;
  2294. private _isPointOnSquare;
  2295. private _isPointOnWheel;
  2296. _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number): boolean;
  2297. _onPointerMove(target: Control, coordinates: BABYLON.Vector2, pointerId: number): void;
  2298. _onPointerUp(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean): void;
  2299. /**
  2300. * This function expands the color picker by creating a color picker dialog with manual
  2301. * color value input and the ability to save colors into an array to be used later in
  2302. * subsequent launches of the dialogue.
  2303. * @param advancedTexture defines the AdvancedDynamicTexture the dialog is assigned to
  2304. * @param options defines size for dialog and options for saved colors. Also accepts last color picked as hex string and saved colors array as hex strings.
  2305. * @returns picked color as a hex string and the saved colors array as hex strings.
  2306. */
  2307. static ShowPickerDialogAsync(advancedTexture: AdvancedDynamicTexture, options: {
  2308. pickerWidth?: string;
  2309. pickerHeight?: string;
  2310. headerHeight?: string;
  2311. lastColor?: string;
  2312. swatchLimit?: number;
  2313. numSwatchesPerLine?: number;
  2314. savedColors?: Array<string>;
  2315. }): Promise<{
  2316. savedColors?: string[];
  2317. pickedColor: string;
  2318. }>;
  2319. }
  2320. }
  2321. declare module BABYLON.GUI {
  2322. /** Class used to create 2D ellipse containers */
  2323. export class Ellipse extends Container {
  2324. name?: string | undefined;
  2325. private _thickness;
  2326. /** Gets or sets border thickness */
  2327. get thickness(): number;
  2328. set thickness(value: number);
  2329. /**
  2330. * Creates a new Ellipse
  2331. * @param name defines the control name
  2332. */
  2333. constructor(name?: string | undefined);
  2334. protected _getTypeName(): string;
  2335. protected _localDraw(context: CanvasRenderingContext2D): void;
  2336. protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  2337. protected _clipForChildren(context: CanvasRenderingContext2D): void;
  2338. }
  2339. }
  2340. declare module BABYLON.GUI {
  2341. /**
  2342. * Class used to create a password control
  2343. */
  2344. export class InputPassword extends InputText {
  2345. protected _beforeRenderText(text: string): string;
  2346. }
  2347. }
  2348. declare module BABYLON.GUI {
  2349. /** Class used to render 2D lines */
  2350. export class Line extends Control {
  2351. name?: string | undefined;
  2352. private _lineWidth;
  2353. private _x1;
  2354. private _y1;
  2355. private _x2;
  2356. private _y2;
  2357. private _dash;
  2358. private _connectedControl;
  2359. private _connectedControlDirtyObserver;
  2360. /** Gets or sets the dash pattern */
  2361. get dash(): Array<number>;
  2362. set dash(value: Array<number>);
  2363. /** Gets or sets the control connected with the line end */
  2364. get connectedControl(): Control;
  2365. set connectedControl(value: Control);
  2366. /** Gets or sets start coordinates on X axis */
  2367. get x1(): string | number;
  2368. set x1(value: string | number);
  2369. /** Gets or sets start coordinates on Y axis */
  2370. get y1(): string | number;
  2371. set y1(value: string | number);
  2372. /** Gets or sets end coordinates on X axis */
  2373. get x2(): string | number;
  2374. set x2(value: string | number);
  2375. /** Gets or sets end coordinates on Y axis */
  2376. get y2(): string | number;
  2377. set y2(value: string | number);
  2378. /** Gets or sets line width */
  2379. get lineWidth(): number;
  2380. set lineWidth(value: number);
  2381. /** Gets or sets horizontal alignment */
  2382. set horizontalAlignment(value: number);
  2383. /** Gets or sets vertical alignment */
  2384. set verticalAlignment(value: number);
  2385. private get _effectiveX2();
  2386. private get _effectiveY2();
  2387. /**
  2388. * Creates a new Line
  2389. * @param name defines the control name
  2390. */
  2391. constructor(name?: string | undefined);
  2392. protected _getTypeName(): string;
  2393. _draw(context: CanvasRenderingContext2D): void;
  2394. _measure(): void;
  2395. protected _computeAlignment(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  2396. /**
  2397. * Move one end of the line given 3D cartesian coordinates.
  2398. * @param position Targeted world position
  2399. * @param scene BABYLON.Scene
  2400. * @param end (opt) Set to true to assign x2 and y2 coordinates of the line. Default assign to x1 and y1.
  2401. */
  2402. moveToVector3(position: BABYLON.Vector3, scene: BABYLON.Scene, end?: boolean): void;
  2403. /**
  2404. * Move one end of the line to a position in screen absolute space.
  2405. * @param projectedPosition Position in screen absolute space (X, Y)
  2406. * @param end (opt) Set to true to assign x2 and y2 coordinates of the line. Default assign to x1 and y1.
  2407. */
  2408. _moveToProjectedPosition(projectedPosition: BABYLON.Vector3, end?: boolean): void;
  2409. }
  2410. }
  2411. declare module BABYLON.GUI {
  2412. /**
  2413. * Class used to store a point for a MultiLine object.
  2414. * The point can be pure 2D coordinates, a mesh or a control
  2415. */
  2416. export class MultiLinePoint {
  2417. private _multiLine;
  2418. private _x;
  2419. private _y;
  2420. private _control;
  2421. private _mesh;
  2422. private _controlObserver;
  2423. private _meshObserver;
  2424. /** @hidden */
  2425. _point: BABYLON.Vector2;
  2426. /**
  2427. * Creates a new MultiLinePoint
  2428. * @param multiLine defines the source MultiLine object
  2429. */
  2430. constructor(multiLine: MultiLine);
  2431. /** Gets or sets x coordinate */
  2432. get x(): string | number;
  2433. set x(value: string | number);
  2434. /** Gets or sets y coordinate */
  2435. get y(): string | number;
  2436. set y(value: string | number);
  2437. /** Gets or sets the control associated with this point */
  2438. get control(): BABYLON.Nullable<Control>;
  2439. set control(value: BABYLON.Nullable<Control>);
  2440. /** Gets or sets the mesh associated with this point */
  2441. get mesh(): BABYLON.Nullable<BABYLON.AbstractMesh>;
  2442. set mesh(value: BABYLON.Nullable<BABYLON.AbstractMesh>);
  2443. /** Resets links */
  2444. resetLinks(): void;
  2445. /**
  2446. * Gets a translation vector
  2447. * @returns the translation vector
  2448. */
  2449. translate(): BABYLON.Vector2;
  2450. private _translatePoint;
  2451. /** Release associated resources */
  2452. dispose(): void;
  2453. }
  2454. }
  2455. declare module BABYLON.GUI {
  2456. /**
  2457. * Class used to create multi line control
  2458. */
  2459. export class MultiLine extends Control {
  2460. name?: string | undefined;
  2461. private _lineWidth;
  2462. private _dash;
  2463. private _points;
  2464. private _minX;
  2465. private _minY;
  2466. private _maxX;
  2467. private _maxY;
  2468. /**
  2469. * Creates a new MultiLine
  2470. * @param name defines the control name
  2471. */
  2472. constructor(name?: string | undefined);
  2473. /** Gets or sets dash pattern */
  2474. get dash(): Array<number>;
  2475. set dash(value: Array<number>);
  2476. /**
  2477. * Gets point stored at specified index
  2478. * @param index defines the index to look for
  2479. * @returns the requested point if found
  2480. */
  2481. getAt(index: number): MultiLinePoint;
  2482. /** Function called when a point is updated */
  2483. onPointUpdate: () => void;
  2484. /**
  2485. * Adds new points to the point collection
  2486. * @param items defines the list of items (mesh, control or 2d coordiantes) to add
  2487. * @returns the list of created MultiLinePoint
  2488. */
  2489. add(...items: (AbstractMesh | Control | {
  2490. x: string | number;
  2491. y: string | number;
  2492. })[]): MultiLinePoint[];
  2493. /**
  2494. * Adds a new point to the point collection
  2495. * @param item defines the item (mesh, control or 2d coordiantes) to add
  2496. * @returns the created MultiLinePoint
  2497. */
  2498. push(item?: (AbstractMesh | Control | {
  2499. x: string | number;
  2500. y: string | number;
  2501. })): MultiLinePoint;
  2502. /**
  2503. * Remove a specific value or point from the active point collection
  2504. * @param value defines the value or point to remove
  2505. */
  2506. remove(value: number | MultiLinePoint): void;
  2507. /**
  2508. * Resets this object to initial state (no point)
  2509. */
  2510. reset(): void;
  2511. /**
  2512. * Resets all links
  2513. */
  2514. resetLinks(): void;
  2515. /** Gets or sets line width */
  2516. get lineWidth(): number;
  2517. set lineWidth(value: number);
  2518. set horizontalAlignment(value: number);
  2519. set verticalAlignment(value: number);
  2520. protected _getTypeName(): string;
  2521. _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: BABYLON.Nullable<Measure>): void;
  2522. protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  2523. _measure(): void;
  2524. protected _computeAlignment(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  2525. dispose(): void;
  2526. }
  2527. }
  2528. declare module BABYLON.GUI {
  2529. /**
  2530. * Class used to create radio button controls
  2531. */
  2532. export class RadioButton extends Control {
  2533. name?: string | undefined;
  2534. private _isChecked;
  2535. private _background;
  2536. private _checkSizeRatio;
  2537. private _thickness;
  2538. /** Gets or sets border thickness */
  2539. get thickness(): number;
  2540. set thickness(value: number);
  2541. /** Gets or sets group name */
  2542. group: string;
  2543. /** BABYLON.Observable raised when isChecked is changed */
  2544. onIsCheckedChangedObservable: BABYLON.Observable<boolean>;
  2545. /** Gets or sets a value indicating the ratio between overall size and check size */
  2546. get checkSizeRatio(): number;
  2547. set checkSizeRatio(value: number);
  2548. /** Gets or sets background color */
  2549. get background(): string;
  2550. set background(value: string);
  2551. /** Gets or sets a boolean indicating if the checkbox is checked or not */
  2552. get isChecked(): boolean;
  2553. set isChecked(value: boolean);
  2554. /**
  2555. * Creates a new RadioButton
  2556. * @param name defines the control name
  2557. */
  2558. constructor(name?: string | undefined);
  2559. protected _getTypeName(): string;
  2560. _draw(context: CanvasRenderingContext2D): void;
  2561. _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number): boolean;
  2562. /**
  2563. * Utility function to easily create a radio button with a header
  2564. * @param title defines the label to use for the header
  2565. * @param group defines the group to use for the radio button
  2566. * @param isChecked defines the initial state of the radio button
  2567. * @param onValueChanged defines the callback to call when value changes
  2568. * @returns a StackPanel containing the radio button and a textBlock
  2569. */
  2570. static AddRadioButtonWithHeader(title: string, group: string, isChecked: boolean, onValueChanged: (button: RadioButton, value: boolean) => void): StackPanel;
  2571. }
  2572. }
  2573. declare module BABYLON.GUI {
  2574. /**
  2575. * Class used to create slider controls
  2576. */
  2577. export class BaseSlider extends Control {
  2578. name?: string | undefined;
  2579. protected _thumbWidth: ValueAndUnit;
  2580. private _minimum;
  2581. private _maximum;
  2582. private _value;
  2583. private _isVertical;
  2584. protected _barOffset: ValueAndUnit;
  2585. private _isThumbClamped;
  2586. protected _displayThumb: boolean;
  2587. private _step;
  2588. private _lastPointerDownID;
  2589. protected _effectiveBarOffset: number;
  2590. protected _renderLeft: number;
  2591. protected _renderTop: number;
  2592. protected _renderWidth: number;
  2593. protected _renderHeight: number;
  2594. protected _backgroundBoxLength: number;
  2595. protected _backgroundBoxThickness: number;
  2596. protected _effectiveThumbThickness: number;
  2597. /** BABYLON.Observable raised when the sldier value changes */
  2598. onValueChangedObservable: BABYLON.Observable<number>;
  2599. /** Gets or sets a boolean indicating if the thumb must be rendered */
  2600. get displayThumb(): boolean;
  2601. set displayThumb(value: boolean);
  2602. /** Gets or sets a step to apply to values (0 by default) */
  2603. get step(): number;
  2604. set step(value: number);
  2605. /** Gets or sets main bar offset (ie. the margin applied to the value bar) */
  2606. get barOffset(): string | number;
  2607. /** Gets main bar offset in pixels*/
  2608. get barOffsetInPixels(): number;
  2609. set barOffset(value: string | number);
  2610. /** Gets or sets thumb width */
  2611. get thumbWidth(): string | number;
  2612. /** Gets thumb width in pixels */
  2613. get thumbWidthInPixels(): number;
  2614. set thumbWidth(value: string | number);
  2615. /** Gets or sets minimum value */
  2616. get minimum(): number;
  2617. set minimum(value: number);
  2618. /** Gets or sets maximum value */
  2619. get maximum(): number;
  2620. set maximum(value: number);
  2621. /** Gets or sets current value */
  2622. get value(): number;
  2623. set value(value: number);
  2624. /**Gets or sets a boolean indicating if the slider should be vertical or horizontal */
  2625. get isVertical(): boolean;
  2626. set isVertical(value: boolean);
  2627. /** Gets or sets a value indicating if the thumb can go over main bar extends */
  2628. get isThumbClamped(): boolean;
  2629. set isThumbClamped(value: boolean);
  2630. /**
  2631. * Creates a new BaseSlider
  2632. * @param name defines the control name
  2633. */
  2634. constructor(name?: string | undefined);
  2635. protected _getTypeName(): string;
  2636. protected _getThumbPosition(): number;
  2637. protected _getThumbThickness(type: string): number;
  2638. protected _prepareRenderingData(type: string): void;
  2639. private _pointerIsDown;
  2640. /** @hidden */
  2641. protected _updateValueFromPointer(x: number, y: number): void;
  2642. _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number): boolean;
  2643. _onPointerMove(target: Control, coordinates: BABYLON.Vector2, pointerId: number): void;
  2644. _onPointerUp(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean): void;
  2645. }
  2646. }
  2647. declare module BABYLON.GUI {
  2648. /**
  2649. * Class used to create slider controls
  2650. */
  2651. export class Slider extends BaseSlider {
  2652. name?: string | undefined;
  2653. private _background;
  2654. private _borderColor;
  2655. private _isThumbCircle;
  2656. protected _displayValueBar: boolean;
  2657. /** Gets or sets a boolean indicating if the value bar must be rendered */
  2658. get displayValueBar(): boolean;
  2659. set displayValueBar(value: boolean);
  2660. /** Gets or sets border color */
  2661. get borderColor(): string;
  2662. set borderColor(value: string);
  2663. /** Gets or sets background color */
  2664. get background(): string;
  2665. set background(value: string);
  2666. /** Gets or sets a boolean indicating if the thumb should be round or square */
  2667. get isThumbCircle(): boolean;
  2668. set isThumbCircle(value: boolean);
  2669. /**
  2670. * Creates a new Slider
  2671. * @param name defines the control name
  2672. */
  2673. constructor(name?: string | undefined);
  2674. protected _getTypeName(): string;
  2675. _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: BABYLON.Nullable<Measure>): void;
  2676. }
  2677. }
  2678. declare module BABYLON.GUI {
  2679. /** Class used to create a RadioGroup
  2680. * which contains groups of radio buttons
  2681. */
  2682. export class SelectorGroup {
  2683. /** name of SelectorGroup */
  2684. name: string;
  2685. private _groupPanel;
  2686. private _selectors;
  2687. private _groupHeader;
  2688. /**
  2689. * Creates a new SelectorGroup
  2690. * @param name of group, used as a group heading
  2691. */
  2692. constructor(
  2693. /** name of SelectorGroup */
  2694. name: string);
  2695. /** Gets the groupPanel of the SelectorGroup */
  2696. get groupPanel(): StackPanel;
  2697. /** Gets the selectors array */
  2698. get selectors(): StackPanel[];
  2699. /** Gets and sets the group header */
  2700. get header(): string;
  2701. set header(label: string);
  2702. /** @hidden */
  2703. private _addGroupHeader;
  2704. /** @hidden*/
  2705. _getSelector(selectorNb: number): StackPanel | undefined;
  2706. /** Removes the selector at the given position
  2707. * @param selectorNb the position of the selector within the group
  2708. */
  2709. removeSelector(selectorNb: number): void;
  2710. }
  2711. /** Class used to create a CheckboxGroup
  2712. * which contains groups of checkbox buttons
  2713. */
  2714. export class CheckboxGroup extends SelectorGroup {
  2715. /** Adds a checkbox as a control
  2716. * @param text is the label for the selector
  2717. * @param func is the function called when the Selector is checked
  2718. * @param checked is true when Selector is checked
  2719. */
  2720. addCheckbox(text: string, func?: (s: boolean) => void, checked?: boolean): void;
  2721. /** @hidden */
  2722. _setSelectorLabel(selectorNb: number, label: string): void;
  2723. /** @hidden */
  2724. _setSelectorLabelColor(selectorNb: number, color: string): void;
  2725. /** @hidden */
  2726. _setSelectorButtonColor(selectorNb: number, color: string): void;
  2727. /** @hidden */
  2728. _setSelectorButtonBackground(selectorNb: number, color: string): void;
  2729. }
  2730. /** Class used to create a RadioGroup
  2731. * which contains groups of radio buttons
  2732. */
  2733. export class RadioGroup extends SelectorGroup {
  2734. private _selectNb;
  2735. /** Adds a radio button as a control
  2736. * @param label is the label for the selector
  2737. * @param func is the function called when the Selector is checked
  2738. * @param checked is true when Selector is checked
  2739. */
  2740. addRadio(label: string, func?: (n: number) => void, checked?: boolean): void;
  2741. /** @hidden */
  2742. _setSelectorLabel(selectorNb: number, label: string): void;
  2743. /** @hidden */
  2744. _setSelectorLabelColor(selectorNb: number, color: string): void;
  2745. /** @hidden */
  2746. _setSelectorButtonColor(selectorNb: number, color: string): void;
  2747. /** @hidden */
  2748. _setSelectorButtonBackground(selectorNb: number, color: string): void;
  2749. }
  2750. /** Class used to create a SliderGroup
  2751. * which contains groups of slider buttons
  2752. */
  2753. export class SliderGroup extends SelectorGroup {
  2754. /**
  2755. * Adds a slider to the SelectorGroup
  2756. * @param label is the label for the SliderBar
  2757. * @param func is the function called when the Slider moves
  2758. * @param unit is a string describing the units used, eg degrees or metres
  2759. * @param min is the minimum value for the Slider
  2760. * @param max is the maximum value for the Slider
  2761. * @param value is the start value for the Slider between min and max
  2762. * @param onValueChange is the function used to format the value displayed, eg radians to degrees
  2763. */
  2764. addSlider(label: string, func?: (v: number) => void, unit?: string, min?: number, max?: number, value?: number, onValueChange?: (v: number) => number): void;
  2765. /** @hidden */
  2766. _setSelectorLabel(selectorNb: number, label: string): void;
  2767. /** @hidden */
  2768. _setSelectorLabelColor(selectorNb: number, color: string): void;
  2769. /** @hidden */
  2770. _setSelectorButtonColor(selectorNb: number, color: string): void;
  2771. /** @hidden */
  2772. _setSelectorButtonBackground(selectorNb: number, color: string): void;
  2773. }
  2774. /** Class used to hold the controls for the checkboxes, radio buttons and sliders
  2775. * @see http://doc.babylonjs.com/how_to/selector
  2776. */
  2777. export class SelectionPanel extends Rectangle {
  2778. /** name of SelectionPanel */
  2779. name: string;
  2780. /** an array of SelectionGroups */
  2781. groups: SelectorGroup[];
  2782. private _panel;
  2783. private _buttonColor;
  2784. private _buttonBackground;
  2785. private _headerColor;
  2786. private _barColor;
  2787. private _barHeight;
  2788. private _spacerHeight;
  2789. private _labelColor;
  2790. private _groups;
  2791. private _bars;
  2792. /**
  2793. * Creates a new SelectionPanel
  2794. * @param name of SelectionPanel
  2795. * @param groups is an array of SelectionGroups
  2796. */
  2797. constructor(
  2798. /** name of SelectionPanel */
  2799. name: string,
  2800. /** an array of SelectionGroups */
  2801. groups?: SelectorGroup[]);
  2802. protected _getTypeName(): string;
  2803. /** Gets or sets the headerColor */
  2804. get headerColor(): string;
  2805. set headerColor(color: string);
  2806. private _setHeaderColor;
  2807. /** Gets or sets the button color */
  2808. get buttonColor(): string;
  2809. set buttonColor(color: string);
  2810. private _setbuttonColor;
  2811. /** Gets or sets the label color */
  2812. get labelColor(): string;
  2813. set labelColor(color: string);
  2814. private _setLabelColor;
  2815. /** Gets or sets the button background */
  2816. get buttonBackground(): string;
  2817. set buttonBackground(color: string);
  2818. private _setButtonBackground;
  2819. /** Gets or sets the color of separator bar */
  2820. get barColor(): string;
  2821. set barColor(color: string);
  2822. private _setBarColor;
  2823. /** Gets or sets the height of separator bar */
  2824. get barHeight(): string;
  2825. set barHeight(value: string);
  2826. private _setBarHeight;
  2827. /** Gets or sets the height of spacers*/
  2828. get spacerHeight(): string;
  2829. set spacerHeight(value: string);
  2830. private _setSpacerHeight;
  2831. /** Adds a bar between groups */
  2832. private _addSpacer;
  2833. /** Add a group to the selection panel
  2834. * @param group is the selector group to add
  2835. */
  2836. addGroup(group: SelectorGroup): void;
  2837. /** Remove the group from the given position
  2838. * @param groupNb is the position of the group in the list
  2839. */
  2840. removeGroup(groupNb: number): void;
  2841. /** Change a group header label
  2842. * @param label is the new group header label
  2843. * @param groupNb is the number of the group to relabel
  2844. * */
  2845. setHeaderName(label: string, groupNb: number): void;
  2846. /** Change selector label to the one given
  2847. * @param label is the new selector label
  2848. * @param groupNb is the number of the groupcontaining the selector
  2849. * @param selectorNb is the number of the selector within a group to relabel
  2850. * */
  2851. relabel(label: string, groupNb: number, selectorNb: number): void;
  2852. /** For a given group position remove the selector at the given position
  2853. * @param groupNb is the number of the group to remove the selector from
  2854. * @param selectorNb is the number of the selector within the group
  2855. */
  2856. removeFromGroupSelector(groupNb: number, selectorNb: number): void;
  2857. /** For a given group position of correct type add a checkbox button
  2858. * @param groupNb is the number of the group to remove the selector from
  2859. * @param label is the label for the selector
  2860. * @param func is the function called when the Selector is checked
  2861. * @param checked is true when Selector is checked
  2862. */
  2863. addToGroupCheckbox(groupNb: number, label: string, func?: () => void, checked?: boolean): void;
  2864. /** For a given group position of correct type add a radio button
  2865. * @param groupNb is the number of the group to remove the selector from
  2866. * @param label is the label for the selector
  2867. * @param func is the function called when the Selector is checked
  2868. * @param checked is true when Selector is checked
  2869. */
  2870. addToGroupRadio(groupNb: number, label: string, func?: () => void, checked?: boolean): void;
  2871. /**
  2872. * For a given slider group add a slider
  2873. * @param groupNb is the number of the group to add the slider to
  2874. * @param label is the label for the Slider
  2875. * @param func is the function called when the Slider moves
  2876. * @param unit is a string describing the units used, eg degrees or metres
  2877. * @param min is the minimum value for the Slider
  2878. * @param max is the maximum value for the Slider
  2879. * @param value is the start value for the Slider between min and max
  2880. * @param onVal is the function used to format the value displayed, eg radians to degrees
  2881. */
  2882. addToGroupSlider(groupNb: number, label: string, func?: () => void, unit?: string, min?: number, max?: number, value?: number, onVal?: (v: number) => number): void;
  2883. }
  2884. }
  2885. declare module BABYLON.GUI {
  2886. /**
  2887. * Class used to hold a the container for ScrollViewer
  2888. * @hidden
  2889. */
  2890. export class _ScrollViewerWindow extends Container {
  2891. parentClientWidth: number;
  2892. parentClientHeight: number;
  2893. private _freezeControls;
  2894. private _parentMeasure;
  2895. private _oldLeft;
  2896. private _oldTop;
  2897. get freezeControls(): boolean;
  2898. set freezeControls(value: boolean);
  2899. private _bucketWidth;
  2900. private _bucketHeight;
  2901. private _buckets;
  2902. private _bucketLen;
  2903. get bucketWidth(): number;
  2904. get bucketHeight(): number;
  2905. setBucketSizes(width: number, height: number): void;
  2906. private _useBuckets;
  2907. private _makeBuckets;
  2908. private _dispatchInBuckets;
  2909. private _updateMeasures;
  2910. private _updateChildrenMeasures;
  2911. /**
  2912. * Creates a new ScrollViewerWindow
  2913. * @param name of ScrollViewerWindow
  2914. */
  2915. constructor(name?: string);
  2916. protected _getTypeName(): string;
  2917. /** @hidden */
  2918. protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  2919. /** @hidden */
  2920. _layout(parentMeasure: Measure, context: CanvasRenderingContext2D): boolean;
  2921. private _scrollChildren;
  2922. private _scrollChildrenWithBuckets;
  2923. /** @hidden */
  2924. _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: Measure): void;
  2925. protected _postMeasure(): void;
  2926. }
  2927. }
  2928. declare module BABYLON.GUI {
  2929. /**
  2930. * Class used to create slider controls
  2931. */
  2932. export class ScrollBar extends BaseSlider {
  2933. name?: string | undefined;
  2934. private _background;
  2935. private _borderColor;
  2936. private _tempMeasure;
  2937. /** Gets or sets border color */
  2938. get borderColor(): string;
  2939. set borderColor(value: string);
  2940. /** Gets or sets background color */
  2941. get background(): string;
  2942. set background(value: string);
  2943. /**
  2944. * Creates a new Slider
  2945. * @param name defines the control name
  2946. */
  2947. constructor(name?: string | undefined);
  2948. protected _getTypeName(): string;
  2949. protected _getThumbThickness(): number;
  2950. _draw(context: CanvasRenderingContext2D): void;
  2951. private _first;
  2952. private _originX;
  2953. private _originY;
  2954. /** @hidden */
  2955. protected _updateValueFromPointer(x: number, y: number): void;
  2956. _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number): boolean;
  2957. }
  2958. }
  2959. declare module BABYLON.GUI {
  2960. /**
  2961. * Class used to create slider controls
  2962. */
  2963. export class ImageScrollBar extends BaseSlider {
  2964. name?: string | undefined;
  2965. private _backgroundBaseImage;
  2966. private _backgroundImage;
  2967. private _thumbImage;
  2968. private _thumbBaseImage;
  2969. private _thumbLength;
  2970. private _thumbHeight;
  2971. private _barImageHeight;
  2972. private _tempMeasure;
  2973. /**
  2974. * Gets or sets the image used to render the background for horizontal bar
  2975. */
  2976. get backgroundImage(): Image;
  2977. set backgroundImage(value: Image);
  2978. /**
  2979. * Gets or sets the image used to render the thumb
  2980. */
  2981. get thumbImage(): Image;
  2982. set thumbImage(value: Image);
  2983. /**
  2984. * Gets or sets the length of the thumb
  2985. */
  2986. get thumbLength(): number;
  2987. set thumbLength(value: number);
  2988. /**
  2989. * Gets or sets the height of the thumb
  2990. */
  2991. get thumbHeight(): number;
  2992. set thumbHeight(value: number);
  2993. /**
  2994. * Gets or sets the height of the bar image
  2995. */
  2996. get barImageHeight(): number;
  2997. set barImageHeight(value: number);
  2998. /**
  2999. * Creates a new ImageScrollBar
  3000. * @param name defines the control name
  3001. */
  3002. constructor(name?: string | undefined);
  3003. protected _getTypeName(): string;
  3004. protected _getThumbThickness(): number;
  3005. _draw(context: CanvasRenderingContext2D): void;
  3006. private _first;
  3007. private _originX;
  3008. private _originY;
  3009. /** @hidden */
  3010. protected _updateValueFromPointer(x: number, y: number): void;
  3011. _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number): boolean;
  3012. }
  3013. }
  3014. declare module BABYLON.GUI {
  3015. /**
  3016. * Class used to hold a viewer window and sliders in a grid
  3017. */
  3018. export class ScrollViewer extends Rectangle {
  3019. private _grid;
  3020. private _horizontalBarSpace;
  3021. private _verticalBarSpace;
  3022. private _dragSpace;
  3023. private _horizontalBar;
  3024. private _verticalBar;
  3025. private _barColor;
  3026. private _barBackground;
  3027. private _barImage;
  3028. private _horizontalBarImage;
  3029. private _verticalBarImage;
  3030. private _barBackgroundImage;
  3031. private _horizontalBarBackgroundImage;
  3032. private _verticalBarBackgroundImage;
  3033. private _barSize;
  3034. private _window;
  3035. private _pointerIsOver;
  3036. private _wheelPrecision;
  3037. private _onPointerObserver;
  3038. private _clientWidth;
  3039. private _clientHeight;
  3040. private _useImageBar;
  3041. private _thumbLength;
  3042. private _thumbHeight;
  3043. private _barImageHeight;
  3044. private _horizontalBarImageHeight;
  3045. private _verticalBarImageHeight;
  3046. /**
  3047. * Gets the horizontal scrollbar
  3048. */
  3049. get horizontalBar(): ScrollBar | ImageScrollBar;
  3050. /**
  3051. * Gets the vertical scrollbar
  3052. */
  3053. get verticalBar(): ScrollBar | ImageScrollBar;
  3054. /**
  3055. * Adds a new control to the current container
  3056. * @param control defines the control to add
  3057. * @returns the current container
  3058. */
  3059. addControl(control: BABYLON.Nullable<Control>): Container;
  3060. /**
  3061. * Removes a control from the current container
  3062. * @param control defines the control to remove
  3063. * @returns the current container
  3064. */
  3065. removeControl(control: Control): Container;
  3066. /** Gets the list of children */
  3067. get children(): Control[];
  3068. _flagDescendantsAsMatrixDirty(): void;
  3069. /**
  3070. * Freezes or unfreezes the controls in the window.
  3071. * When controls are frozen, the scroll viewer can render a lot more quickly but updates to positions/sizes of controls
  3072. * are not taken into account. If you want to change positions/sizes, unfreeze, perform the changes then freeze again
  3073. */
  3074. get freezeControls(): boolean;
  3075. set freezeControls(value: boolean);
  3076. /** Gets the bucket width */
  3077. get bucketWidth(): number;
  3078. /** Gets the bucket height */
  3079. get bucketHeight(): number;
  3080. /**
  3081. * Sets the bucket sizes.
  3082. * When freezeControls is true, setting a non-zero bucket size will improve performances by updating only
  3083. * controls that are visible. The bucket sizes is used to subdivide (internally) the window area to smaller areas into which
  3084. * controls are dispatched. So, the size should be roughly equals to the mean size of all the controls of
  3085. * the window. To disable the usage of buckets, sets either width or height (or both) to 0.
  3086. * Please note that using this option will raise the memory usage (the higher the bucket sizes, the less memory
  3087. * used), that's why it is not enabled by default.
  3088. * @param width width of the bucket
  3089. * @param height height of the bucket
  3090. */
  3091. setBucketSizes(width: number, height: number): void;
  3092. private _forceHorizontalBar;
  3093. private _forceVerticalBar;
  3094. /**
  3095. * Forces the horizontal scroll bar to be displayed
  3096. */
  3097. get forceHorizontalBar(): boolean;
  3098. set forceHorizontalBar(value: boolean);
  3099. /**
  3100. * Forces the vertical scroll bar to be displayed
  3101. */
  3102. get forceVerticalBar(): boolean;
  3103. set forceVerticalBar(value: boolean);
  3104. /**
  3105. * Creates a new ScrollViewer
  3106. * @param name of ScrollViewer
  3107. */
  3108. constructor(name?: string, isImageBased?: boolean);
  3109. /** Reset the scroll viewer window to initial size */
  3110. resetWindow(): void;
  3111. protected _getTypeName(): string;
  3112. private _buildClientSizes;
  3113. protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  3114. protected _postMeasure(): void;
  3115. /**
  3116. * Gets or sets the mouse wheel precision
  3117. * from 0 to 1 with a default value of 0.05
  3118. * */
  3119. get wheelPrecision(): number;
  3120. set wheelPrecision(value: number);
  3121. /** Gets or sets the scroll bar container background color */
  3122. get scrollBackground(): string;
  3123. set scrollBackground(color: string);
  3124. /** Gets or sets the bar color */
  3125. get barColor(): string;
  3126. set barColor(color: string);
  3127. /** Gets or sets the bar image */
  3128. get thumbImage(): Image;
  3129. set thumbImage(value: Image);
  3130. /** Gets or sets the horizontal bar image */
  3131. get horizontalThumbImage(): Image;
  3132. set horizontalThumbImage(value: Image);
  3133. /** Gets or sets the vertical bar image */
  3134. get verticalThumbImage(): Image;
  3135. set verticalThumbImage(value: Image);
  3136. /** Gets or sets the size of the bar */
  3137. get barSize(): number;
  3138. set barSize(value: number);
  3139. /** Gets or sets the length of the thumb */
  3140. get thumbLength(): number;
  3141. set thumbLength(value: number);
  3142. /** Gets or sets the height of the thumb */
  3143. get thumbHeight(): number;
  3144. set thumbHeight(value: number);
  3145. /** Gets or sets the height of the bar image */
  3146. get barImageHeight(): number;
  3147. set barImageHeight(value: number);
  3148. /** Gets or sets the height of the horizontal bar image */
  3149. get horizontalBarImageHeight(): number;
  3150. set horizontalBarImageHeight(value: number);
  3151. /** Gets or sets the height of the vertical bar image */
  3152. get verticalBarImageHeight(): number;
  3153. set verticalBarImageHeight(value: number);
  3154. /** Gets or sets the bar background */
  3155. get barBackground(): string;
  3156. set barBackground(color: string);
  3157. /** Gets or sets the bar background image */
  3158. get barImage(): Image;
  3159. set barImage(value: Image);
  3160. /** Gets or sets the horizontal bar background image */
  3161. get horizontalBarImage(): Image;
  3162. set horizontalBarImage(value: Image);
  3163. /** Gets or sets the vertical bar background image */
  3164. get verticalBarImage(): Image;
  3165. set verticalBarImage(value: Image);
  3166. private _setWindowPosition;
  3167. /** @hidden */
  3168. private _updateScroller;
  3169. _link(host: AdvancedDynamicTexture): void;
  3170. /** @hidden */
  3171. private _addBar;
  3172. /** @hidden */
  3173. private _attachWheel;
  3174. _renderHighlightSpecific(context: CanvasRenderingContext2D): void;
  3175. /** Releases associated resources */
  3176. dispose(): void;
  3177. }
  3178. }
  3179. declare module BABYLON.GUI {
  3180. /** Class used to render a grid */
  3181. export class DisplayGrid extends Control {
  3182. name?: string | undefined;
  3183. private _cellWidth;
  3184. private _cellHeight;
  3185. private _minorLineTickness;
  3186. private _minorLineColor;
  3187. private _majorLineTickness;
  3188. private _majorLineColor;
  3189. private _majorLineFrequency;
  3190. private _background;
  3191. private _displayMajorLines;
  3192. private _displayMinorLines;
  3193. /** Gets or sets a boolean indicating if minor lines must be rendered (true by default)) */
  3194. get displayMinorLines(): boolean;
  3195. set displayMinorLines(value: boolean);
  3196. /** Gets or sets a boolean indicating if major lines must be rendered (true by default)) */
  3197. get displayMajorLines(): boolean;
  3198. set displayMajorLines(value: boolean);
  3199. /** Gets or sets background color (Black by default) */
  3200. get background(): string;
  3201. set background(value: string);
  3202. /** Gets or sets the width of each cell (20 by default) */
  3203. get cellWidth(): number;
  3204. set cellWidth(value: number);
  3205. /** Gets or sets the height of each cell (20 by default) */
  3206. get cellHeight(): number;
  3207. set cellHeight(value: number);
  3208. /** Gets or sets the tickness of minor lines (1 by default) */
  3209. get minorLineTickness(): number;
  3210. set minorLineTickness(value: number);
  3211. /** Gets or sets the color of minor lines (DarkGray by default) */
  3212. get minorLineColor(): string;
  3213. set minorLineColor(value: string);
  3214. /** Gets or sets the tickness of major lines (2 by default) */
  3215. get majorLineTickness(): number;
  3216. set majorLineTickness(value: number);
  3217. /** Gets or sets the color of major lines (White by default) */
  3218. get majorLineColor(): string;
  3219. set majorLineColor(value: string);
  3220. /** Gets or sets the frequency of major lines (default is 1 every 5 minor lines)*/
  3221. get majorLineFrequency(): number;
  3222. set majorLineFrequency(value: number);
  3223. /**
  3224. * Creates a new GridDisplayRectangle
  3225. * @param name defines the control name
  3226. */
  3227. constructor(name?: string | undefined);
  3228. _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: BABYLON.Nullable<Measure>): void;
  3229. protected _getTypeName(): string;
  3230. }
  3231. }
  3232. declare module BABYLON.GUI {
  3233. /**
  3234. * Class used to create slider controls based on images
  3235. */
  3236. export class ImageBasedSlider extends BaseSlider {
  3237. name?: string | undefined;
  3238. private _backgroundImage;
  3239. private _thumbImage;
  3240. private _valueBarImage;
  3241. private _tempMeasure;
  3242. get displayThumb(): boolean;
  3243. set displayThumb(value: boolean);
  3244. /**
  3245. * Gets or sets the image used to render the background
  3246. */
  3247. get backgroundImage(): Image;
  3248. set backgroundImage(value: Image);
  3249. /**
  3250. * Gets or sets the image used to render the value bar
  3251. */
  3252. get valueBarImage(): Image;
  3253. set valueBarImage(value: Image);
  3254. /**
  3255. * Gets or sets the image used to render the thumb
  3256. */
  3257. get thumbImage(): Image;
  3258. set thumbImage(value: Image);
  3259. /**
  3260. * Creates a new ImageBasedSlider
  3261. * @param name defines the control name
  3262. */
  3263. constructor(name?: string | undefined);
  3264. protected _getTypeName(): string;
  3265. _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: BABYLON.Nullable<Measure>): void;
  3266. }
  3267. }
  3268. declare module BABYLON.GUI {
  3269. /**
  3270. * Forcing an export so that this code will execute
  3271. * @hidden
  3272. */
  3273. const name = "Statics";
  3274. }
  3275. declare module BABYLON.GUI {
  3276. /**
  3277. * This class can be used to get instrumentation data from a AdvancedDynamicTexture object
  3278. */
  3279. export class AdvancedDynamicTextureInstrumentation implements BABYLON.IDisposable {
  3280. /**
  3281. * Define the instrumented AdvancedDynamicTexture.
  3282. */
  3283. texture: AdvancedDynamicTexture;
  3284. private _captureRenderTime;
  3285. private _renderTime;
  3286. private _captureLayoutTime;
  3287. private _layoutTime;
  3288. private _onBeginRenderObserver;
  3289. private _onEndRenderObserver;
  3290. private _onBeginLayoutObserver;
  3291. private _onEndLayoutObserver;
  3292. /**
  3293. * Gets the perf counter used to capture render time
  3294. */
  3295. get renderTimeCounter(): BABYLON.PerfCounter;
  3296. /**
  3297. * Gets the perf counter used to capture layout time
  3298. */
  3299. get layoutTimeCounter(): BABYLON.PerfCounter;
  3300. /**
  3301. * Enable or disable the render time capture
  3302. */
  3303. get captureRenderTime(): boolean;
  3304. set captureRenderTime(value: boolean);
  3305. /**
  3306. * Enable or disable the layout time capture
  3307. */
  3308. get captureLayoutTime(): boolean;
  3309. set captureLayoutTime(value: boolean);
  3310. /**
  3311. * Instantiates a new advanced dynamic texture instrumentation.
  3312. * This class can be used to get instrumentation data from an AdvancedDynamicTexture object
  3313. * @param texture Defines the AdvancedDynamicTexture to instrument
  3314. */
  3315. constructor(
  3316. /**
  3317. * Define the instrumented AdvancedDynamicTexture.
  3318. */
  3319. texture: AdvancedDynamicTexture);
  3320. /**
  3321. * Dispose and release associated resources.
  3322. */
  3323. dispose(): void;
  3324. }
  3325. }
  3326. declare module BABYLON.GUI {
  3327. /**
  3328. * Class used to load GUI via XML.
  3329. */
  3330. export class XmlLoader {
  3331. private _nodes;
  3332. private _nodeTypes;
  3333. private _isLoaded;
  3334. private _objectAttributes;
  3335. private _parentClass;
  3336. /**
  3337. * Create a new xml loader
  3338. * @param parentClass Sets the class context. Used when the loader is instanced inside a class and not in a global context
  3339. */
  3340. constructor(parentClass?: null);
  3341. private _getChainElement;
  3342. private _getClassAttribute;
  3343. private _createGuiElement;
  3344. private _parseGrid;
  3345. private _parseElement;
  3346. private _prepareSourceElement;
  3347. private _parseElementsFromSource;
  3348. private _parseXml;
  3349. /**
  3350. * Gets if the loading has finished.
  3351. * @returns whether the loading has finished or not
  3352. */
  3353. isLoaded(): boolean;
  3354. /**
  3355. * Gets a loaded node / control by id.
  3356. * @param id the Controls id set in the xml
  3357. * @returns element of type Control
  3358. */
  3359. getNodeById(id: string): any;
  3360. /**
  3361. * Gets all loaded nodes / controls
  3362. * @returns Array of controls
  3363. */
  3364. getNodes(): any;
  3365. /**
  3366. * Initiates the xml layout loading
  3367. * @param xmlFile defines the xml layout to load
  3368. * @param rootNode defines the node / control to use as a parent for the loaded layout controls.
  3369. * @param callback defines the callback called on layout load.
  3370. */
  3371. loadLayout(xmlFile: any, rootNode: any, callback: any): void;
  3372. }
  3373. }
  3374. declare module BABYLON.GUI {
  3375. /**
  3376. * Class used to create containers for controls
  3377. */
  3378. export class Container3D extends Control3D {
  3379. private _blockLayout;
  3380. /**
  3381. * Gets the list of child controls
  3382. */
  3383. protected _children: Control3D[];
  3384. /**
  3385. * Gets the list of child controls
  3386. */
  3387. get children(): Array<Control3D>;
  3388. /**
  3389. * Gets or sets a boolean indicating if the layout must be blocked (default is false).
  3390. * This is helpful to optimize layout operation when adding multiple children in a row
  3391. */
  3392. get blockLayout(): boolean;
  3393. set blockLayout(value: boolean);
  3394. /**
  3395. * Creates a new container
  3396. * @param name defines the container name
  3397. */
  3398. constructor(name?: string);
  3399. /**
  3400. * Force the container to update the layout. Please note that it will not take blockLayout property in account
  3401. * @returns the current container
  3402. */
  3403. updateLayout(): Container3D;
  3404. /**
  3405. * Gets a boolean indicating if the given control is in the children of this control
  3406. * @param control defines the control to check
  3407. * @returns true if the control is in the child list
  3408. */
  3409. containsControl(control: Control3D): boolean;
  3410. /**
  3411. * Adds a control to the children of this control
  3412. * @param control defines the control to add
  3413. * @returns the current container
  3414. */
  3415. addControl(control: Control3D): Container3D;
  3416. /**
  3417. * This function will be called everytime a new control is added
  3418. */
  3419. protected _arrangeChildren(): void;
  3420. protected _createNode(scene: BABYLON.Scene): BABYLON.Nullable<BABYLON.TransformNode>;
  3421. /**
  3422. * Removes a control from the children of this control
  3423. * @param control defines the control to remove
  3424. * @returns the current container
  3425. */
  3426. removeControl(control: Control3D): Container3D;
  3427. protected _getTypeName(): string;
  3428. /**
  3429. * Releases all associated resources
  3430. */
  3431. dispose(): void;
  3432. /** Control rotation will remain unchanged */
  3433. static readonly UNSET_ORIENTATION: number;
  3434. /** Control will rotate to make it look at sphere central axis */
  3435. static readonly FACEORIGIN_ORIENTATION: number;
  3436. /** Control will rotate to make it look back at sphere central axis */
  3437. static readonly FACEORIGINREVERSED_ORIENTATION: number;
  3438. /** Control will rotate to look at z axis (0, 0, 1) */
  3439. static readonly FACEFORWARD_ORIENTATION: number;
  3440. /** Control will rotate to look at negative z axis (0, 0, -1) */
  3441. static readonly FACEFORWARDREVERSED_ORIENTATION: number;
  3442. }
  3443. }
  3444. declare module BABYLON.GUI {
  3445. /**
  3446. * Class used to manage 3D user interface
  3447. * @see http://doc.babylonjs.com/how_to/gui3d
  3448. */
  3449. export class GUI3DManager implements BABYLON.IDisposable {
  3450. private _scene;
  3451. private _sceneDisposeObserver;
  3452. private _utilityLayer;
  3453. private _rootContainer;
  3454. private _pointerObserver;
  3455. private _pointerOutObserver;
  3456. /** @hidden */
  3457. _lastPickedControl: Control3D;
  3458. /** @hidden */
  3459. _lastControlOver: {
  3460. [pointerId: number]: Control3D;
  3461. };
  3462. /** @hidden */
  3463. _lastControlDown: {
  3464. [pointerId: number]: Control3D;
  3465. };
  3466. /**
  3467. * BABYLON.Observable raised when the point picked by the pointer events changed
  3468. */
  3469. onPickedPointChangedObservable: BABYLON.Observable<BABYLON.Nullable<BABYLON.Vector3>>;
  3470. /** @hidden */
  3471. _sharedMaterials: {
  3472. [key: string]: BABYLON.Material;
  3473. };
  3474. /** Gets the hosting scene */
  3475. get scene(): BABYLON.Scene;
  3476. /** Gets associated utility layer */
  3477. get utilityLayer(): BABYLON.Nullable<BABYLON.UtilityLayerRenderer>;
  3478. /**
  3479. * Creates a new GUI3DManager
  3480. * @param scene
  3481. */
  3482. constructor(scene?: BABYLON.Scene);
  3483. private _handlePointerOut;
  3484. private _doPicking;
  3485. /**
  3486. * Gets the root container
  3487. */
  3488. get rootContainer(): Container3D;
  3489. /**
  3490. * Gets a boolean indicating if the given control is in the root child list
  3491. * @param control defines the control to check
  3492. * @returns true if the control is in the root child list
  3493. */
  3494. containsControl(control: Control3D): boolean;
  3495. /**
  3496. * Adds a control to the root child list
  3497. * @param control defines the control to add
  3498. * @returns the current manager
  3499. */
  3500. addControl(control: Control3D): GUI3DManager;
  3501. /**
  3502. * Removes a control from the root child list
  3503. * @param control defines the control to remove
  3504. * @returns the current container
  3505. */
  3506. removeControl(control: Control3D): GUI3DManager;
  3507. /**
  3508. * Releases all associated resources
  3509. */
  3510. dispose(): void;
  3511. }
  3512. }
  3513. declare module BABYLON.GUI {
  3514. /**
  3515. * Class used to transport BABYLON.Vector3 information for pointer events
  3516. */
  3517. export class Vector3WithInfo extends BABYLON.Vector3 {
  3518. /** defines the current mouse button index */
  3519. buttonIndex: number;
  3520. /**
  3521. * Creates a new Vector3WithInfo
  3522. * @param source defines the vector3 data to transport
  3523. * @param buttonIndex defines the current mouse button index
  3524. */
  3525. constructor(source: BABYLON.Vector3,
  3526. /** defines the current mouse button index */
  3527. buttonIndex?: number);
  3528. }
  3529. }
  3530. declare module BABYLON.GUI {
  3531. /**
  3532. * Class used as base class for controls
  3533. */
  3534. export class Control3D implements BABYLON.IDisposable, BABYLON.IBehaviorAware<Control3D> {
  3535. /** Defines the control name */
  3536. name?: string | undefined;
  3537. /** @hidden */
  3538. _host: GUI3DManager;
  3539. private _node;
  3540. private _downCount;
  3541. private _enterCount;
  3542. private _downPointerIds;
  3543. private _isVisible;
  3544. /** Gets or sets the control position in world space */
  3545. get position(): BABYLON.Vector3;
  3546. set position(value: BABYLON.Vector3);
  3547. /** Gets or sets the control scaling in world space */
  3548. get scaling(): BABYLON.Vector3;
  3549. set scaling(value: BABYLON.Vector3);
  3550. /** Callback used to start pointer enter animation */
  3551. pointerEnterAnimation: () => void;
  3552. /** Callback used to start pointer out animation */
  3553. pointerOutAnimation: () => void;
  3554. /** Callback used to start pointer down animation */
  3555. pointerDownAnimation: () => void;
  3556. /** Callback used to start pointer up animation */
  3557. pointerUpAnimation: () => void;
  3558. /**
  3559. * An event triggered when the pointer move over the control
  3560. */
  3561. onPointerMoveObservable: BABYLON.Observable<BABYLON.Vector3>;
  3562. /**
  3563. * An event triggered when the pointer move out of the control
  3564. */
  3565. onPointerOutObservable: BABYLON.Observable<Control3D>;
  3566. /**
  3567. * An event triggered when the pointer taps the control
  3568. */
  3569. onPointerDownObservable: BABYLON.Observable<Vector3WithInfo>;
  3570. /**
  3571. * An event triggered when pointer is up
  3572. */
  3573. onPointerUpObservable: BABYLON.Observable<Vector3WithInfo>;
  3574. /**
  3575. * An event triggered when a control is clicked on (with a mouse)
  3576. */
  3577. onPointerClickObservable: BABYLON.Observable<Vector3WithInfo>;
  3578. /**
  3579. * An event triggered when pointer enters the control
  3580. */
  3581. onPointerEnterObservable: BABYLON.Observable<Control3D>;
  3582. /**
  3583. * Gets or sets the parent container
  3584. */
  3585. parent: BABYLON.Nullable<Container3D>;
  3586. private _behaviors;
  3587. /**
  3588. * Gets the list of attached behaviors
  3589. * @see http://doc.babylonjs.com/features/behaviour
  3590. */
  3591. get behaviors(): BABYLON.Behavior<Control3D>[];
  3592. /**
  3593. * Attach a behavior to the control
  3594. * @see http://doc.babylonjs.com/features/behaviour
  3595. * @param behavior defines the behavior to attach
  3596. * @returns the current control
  3597. */
  3598. addBehavior(behavior: BABYLON.Behavior<Control3D>): Control3D;
  3599. /**
  3600. * Remove an attached behavior
  3601. * @see http://doc.babylonjs.com/features/behaviour
  3602. * @param behavior defines the behavior to attach
  3603. * @returns the current control
  3604. */
  3605. removeBehavior(behavior: BABYLON.Behavior<Control3D>): Control3D;
  3606. /**
  3607. * Gets an attached behavior by name
  3608. * @param name defines the name of the behavior to look for
  3609. * @see http://doc.babylonjs.com/features/behaviour
  3610. * @returns null if behavior was not found else the requested behavior
  3611. */
  3612. getBehaviorByName(name: string): BABYLON.Nullable<BABYLON.Behavior<Control3D>>;
  3613. /** Gets or sets a boolean indicating if the control is visible */
  3614. get isVisible(): boolean;
  3615. set isVisible(value: boolean);
  3616. /**
  3617. * Creates a new control
  3618. * @param name defines the control name
  3619. */
  3620. constructor(
  3621. /** Defines the control name */
  3622. name?: string | undefined);
  3623. /**
  3624. * Gets a string representing the class name
  3625. */
  3626. get typeName(): string;
  3627. /**
  3628. * Get the current class name of the control.
  3629. * @returns current class name
  3630. */
  3631. getClassName(): string;
  3632. protected _getTypeName(): string;
  3633. /**
  3634. * Gets the transform node used by this control
  3635. */
  3636. get node(): BABYLON.Nullable<BABYLON.TransformNode>;
  3637. /**
  3638. * Gets the mesh used to render this control
  3639. */
  3640. get mesh(): BABYLON.Nullable<BABYLON.AbstractMesh>;
  3641. /**
  3642. * Link the control as child of the given node
  3643. * @param node defines the node to link to. Use null to unlink the control
  3644. * @returns the current control
  3645. */
  3646. linkToTransformNode(node: BABYLON.Nullable<BABYLON.TransformNode>): Control3D;
  3647. /** @hidden **/
  3648. _prepareNode(scene: BABYLON.Scene): void;
  3649. /**
  3650. * Node creation.
  3651. * Can be overriden by children
  3652. * @param scene defines the scene where the node must be attached
  3653. * @returns the attached node or null if none. Must return a BABYLON.Mesh or BABYLON.AbstractMesh if there is an atttached visible object
  3654. */
  3655. protected _createNode(scene: BABYLON.Scene): BABYLON.Nullable<BABYLON.TransformNode>;
  3656. /**
  3657. * Affect a material to the given mesh
  3658. * @param mesh defines the mesh which will represent the control
  3659. */
  3660. protected _affectMaterial(mesh: BABYLON.AbstractMesh): void;
  3661. /** @hidden */
  3662. _onPointerMove(target: Control3D, coordinates: BABYLON.Vector3): void;
  3663. /** @hidden */
  3664. _onPointerEnter(target: Control3D): boolean;
  3665. /** @hidden */
  3666. _onPointerOut(target: Control3D): void;
  3667. /** @hidden */
  3668. _onPointerDown(target: Control3D, coordinates: BABYLON.Vector3, pointerId: number, buttonIndex: number): boolean;
  3669. /** @hidden */
  3670. _onPointerUp(target: Control3D, coordinates: BABYLON.Vector3, pointerId: number, buttonIndex: number, notifyClick: boolean): void;
  3671. /** @hidden */
  3672. forcePointerUp(pointerId?: BABYLON.Nullable<number>): void;
  3673. /** @hidden */
  3674. _processObservables(type: number, pickedPoint: BABYLON.Vector3, pointerId: number, buttonIndex: number): boolean;
  3675. /** @hidden */
  3676. _disposeNode(): void;
  3677. /**
  3678. * Releases all associated resources
  3679. */
  3680. dispose(): void;
  3681. }
  3682. }
  3683. declare module BABYLON.GUI {
  3684. /**
  3685. * Class used as a root to all buttons
  3686. */
  3687. export class AbstractButton3D extends Control3D {
  3688. /**
  3689. * Creates a new button
  3690. * @param name defines the control name
  3691. */
  3692. constructor(name?: string);
  3693. protected _getTypeName(): string;
  3694. protected _createNode(scene: BABYLON.Scene): BABYLON.TransformNode;
  3695. }
  3696. }
  3697. declare module BABYLON.GUI {
  3698. /**
  3699. * Class used to create a button in 3D
  3700. */
  3701. export class Button3D extends AbstractButton3D {
  3702. /** @hidden */
  3703. protected _currentMaterial: BABYLON.Material;
  3704. private _facadeTexture;
  3705. private _content;
  3706. private _contentResolution;
  3707. private _contentScaleRatio;
  3708. /**
  3709. * Gets or sets the texture resolution used to render content (512 by default)
  3710. */
  3711. get contentResolution(): BABYLON.int;
  3712. set contentResolution(value: BABYLON.int);
  3713. /**
  3714. * Gets or sets the texture scale ratio used to render content (2 by default)
  3715. */
  3716. get contentScaleRatio(): number;
  3717. set contentScaleRatio(value: number);
  3718. protected _disposeFacadeTexture(): void;
  3719. protected _resetContent(): void;
  3720. /**
  3721. * Creates a new button
  3722. * @param name defines the control name
  3723. */
  3724. constructor(name?: string);
  3725. /**
  3726. * Gets or sets the GUI 2D content used to display the button's facade
  3727. */
  3728. get content(): Control;
  3729. set content(value: Control);
  3730. /**
  3731. * Apply the facade texture (created from the content property).
  3732. * This function can be overloaded by child classes
  3733. * @param facadeTexture defines the AdvancedDynamicTexture to use
  3734. */
  3735. protected _applyFacade(facadeTexture: AdvancedDynamicTexture): void;
  3736. protected _getTypeName(): string;
  3737. protected _createNode(scene: BABYLON.Scene): BABYLON.TransformNode;
  3738. protected _affectMaterial(mesh: BABYLON.AbstractMesh): void;
  3739. /**
  3740. * Releases all associated resources
  3741. */
  3742. dispose(): void;
  3743. }
  3744. }
  3745. declare module BABYLON.GUI {
  3746. /**
  3747. * Abstract class used to create a container panel deployed on the surface of a volume
  3748. */
  3749. export abstract class VolumeBasedPanel extends Container3D {
  3750. private _columns;
  3751. private _rows;
  3752. private _rowThenColum;
  3753. private _orientation;
  3754. protected _cellWidth: number;
  3755. protected _cellHeight: number;
  3756. /**
  3757. * Gets or sets the distance between elements
  3758. */
  3759. margin: number;
  3760. /**
  3761. * Gets or sets the orientation to apply to all controls (BABYLON.Container3D.FaceOriginReversedOrientation by default)
  3762. * | Value | Type | Description |
  3763. * | ----- | ----------------------------------- | ----------- |
  3764. * | 0 | UNSET_ORIENTATION | Control rotation will remain unchanged |
  3765. * | 1 | FACEORIGIN_ORIENTATION | Control will rotate to make it look at sphere central axis |
  3766. * | 2 | FACEORIGINREVERSED_ORIENTATION | Control will rotate to make it look back at sphere central axis |
  3767. * | 3 | FACEFORWARD_ORIENTATION | Control will rotate to look at z axis (0, 0, 1) |
  3768. * | 4 | FACEFORWARDREVERSED_ORIENTATION | Control will rotate to look at negative z axis (0, 0, -1) |
  3769. */
  3770. get orientation(): number;
  3771. set orientation(value: number);
  3772. /**
  3773. * Gets or sets the number of columns requested (10 by default).
  3774. * The panel will automatically compute the number of rows based on number of child controls.
  3775. */
  3776. get columns(): BABYLON.int;
  3777. set columns(value: BABYLON.int);
  3778. /**
  3779. * Gets or sets a the number of rows requested.
  3780. * The panel will automatically compute the number of columns based on number of child controls.
  3781. */
  3782. get rows(): BABYLON.int;
  3783. set rows(value: BABYLON.int);
  3784. /**
  3785. * Creates new VolumeBasedPanel
  3786. */
  3787. constructor();
  3788. protected _arrangeChildren(): void;
  3789. /** Child classes must implement this function to provide correct control positioning */
  3790. protected abstract _mapGridNode(control: Control3D, nodePosition: BABYLON.Vector3): void;
  3791. /** Child classes can implement this function to provide additional processing */
  3792. protected _finalProcessing(): void;
  3793. }
  3794. }
  3795. declare module BABYLON.GUI {
  3796. /**
  3797. * Class used to create a container panel deployed on the surface of a cylinder
  3798. */
  3799. export class CylinderPanel extends VolumeBasedPanel {
  3800. private _radius;
  3801. /**
  3802. * Gets or sets the radius of the cylinder where to project controls (5 by default)
  3803. */
  3804. get radius(): BABYLON.float;
  3805. set radius(value: BABYLON.float);
  3806. protected _mapGridNode(control: Control3D, nodePosition: BABYLON.Vector3): void;
  3807. private _cylindricalMapping;
  3808. }
  3809. }
  3810. declare module BABYLON.GUI {
  3811. /** @hidden */
  3812. export var fluentVertexShader: {
  3813. name: string;
  3814. shader: string;
  3815. };
  3816. }
  3817. declare module BABYLON.GUI {
  3818. /** @hidden */
  3819. export var fluentPixelShader: {
  3820. name: string;
  3821. shader: string;
  3822. };
  3823. }
  3824. declare module BABYLON.GUI {
  3825. /** @hidden */
  3826. export class FluentMaterialDefines extends BABYLON.MaterialDefines {
  3827. INNERGLOW: boolean;
  3828. BORDER: boolean;
  3829. HOVERLIGHT: boolean;
  3830. TEXTURE: boolean;
  3831. constructor();
  3832. }
  3833. /**
  3834. * Class used to render controls with fluent desgin
  3835. */
  3836. export class FluentMaterial extends BABYLON.PushMaterial {
  3837. /**
  3838. * Gets or sets inner glow intensity. A value of 0 means no glow (default is 0.5)
  3839. */
  3840. innerGlowColorIntensity: number;
  3841. /**
  3842. * Gets or sets the inner glow color (white by default)
  3843. */
  3844. innerGlowColor: BABYLON.Color3;
  3845. /**
  3846. * Gets or sets alpha value (default is 1.0)
  3847. */
  3848. alpha: number;
  3849. /**
  3850. * Gets or sets the albedo color (Default is BABYLON.Color3(0.3, 0.35, 0.4))
  3851. */
  3852. albedoColor: BABYLON.Color3;
  3853. /**
  3854. * Gets or sets a boolean indicating if borders must be rendered (default is false)
  3855. */
  3856. renderBorders: boolean;
  3857. /**
  3858. * Gets or sets border width (default is 0.5)
  3859. */
  3860. borderWidth: number;
  3861. /**
  3862. * Gets or sets a value indicating the smoothing value applied to border edges (0.02 by default)
  3863. */
  3864. edgeSmoothingValue: number;
  3865. /**
  3866. * Gets or sets the minimum value that can be applied to border width (default is 0.1)
  3867. */
  3868. borderMinValue: number;
  3869. /**
  3870. * Gets or sets a boolean indicating if hover light must be rendered (default is false)
  3871. */
  3872. renderHoverLight: boolean;
  3873. /**
  3874. * Gets or sets the radius used to render the hover light (default is 1.0)
  3875. */
  3876. hoverRadius: number;
  3877. /**
  3878. * Gets or sets the color used to render the hover light (default is BABYLON.Color4(0.3, 0.3, 0.3, 1.0))
  3879. */
  3880. hoverColor: BABYLON.Color4;
  3881. /**
  3882. * Gets or sets the hover light position in world space (default is BABYLON.Vector3.Zero())
  3883. */
  3884. hoverPosition: BABYLON.Vector3;
  3885. private _albedoTexture;
  3886. /** Gets or sets the texture to use for albedo color */
  3887. albedoTexture: BABYLON.Nullable<BABYLON.BaseTexture>;
  3888. /**
  3889. * Creates a new Fluent material
  3890. * @param name defines the name of the material
  3891. * @param scene defines the hosting scene
  3892. */
  3893. constructor(name: string, scene: BABYLON.Scene);
  3894. needAlphaBlending(): boolean;
  3895. needAlphaTesting(): boolean;
  3896. getAlphaTestTexture(): BABYLON.Nullable<BABYLON.BaseTexture>;
  3897. isReadyForSubMesh(mesh: BABYLON.AbstractMesh, subMesh: BABYLON.SubMesh, useInstances?: boolean): boolean;
  3898. bindForSubMesh(world: BABYLON.Matrix, mesh: BABYLON.Mesh, subMesh: BABYLON.SubMesh): void;
  3899. getActiveTextures(): BABYLON.BaseTexture[];
  3900. hasTexture(texture: BABYLON.BaseTexture): boolean;
  3901. dispose(forceDisposeEffect?: boolean): void;
  3902. clone(name: string): FluentMaterial;
  3903. serialize(): any;
  3904. getClassName(): string;
  3905. static Parse(source: any, scene: BABYLON.Scene, rootUrl: string): FluentMaterial;
  3906. }
  3907. }
  3908. declare module BABYLON.GUI {
  3909. /**
  3910. * Class used to create a holographic button in 3D
  3911. */
  3912. export class HolographicButton extends Button3D {
  3913. private _backPlate;
  3914. private _textPlate;
  3915. private _frontPlate;
  3916. private _text;
  3917. private _imageUrl;
  3918. private _shareMaterials;
  3919. private _frontMaterial;
  3920. private _backMaterial;
  3921. private _plateMaterial;
  3922. private _pickedPointObserver;
  3923. private _tooltipFade;
  3924. private _tooltipTextBlock;
  3925. private _tooltipTexture;
  3926. private _tooltipMesh;
  3927. private _tooltipHoverObserver;
  3928. private _tooltipOutObserver;
  3929. private _disposeTooltip;
  3930. /**
  3931. * Rendering ground id of all the mesh in the button
  3932. */
  3933. set renderingGroupId(id: number);
  3934. get renderingGroupId(): number;
  3935. /**
  3936. * Text to be displayed on the tooltip shown when hovering on the button. When set to null tooltip is disabled. (Default: null)
  3937. */
  3938. set tooltipText(text: BABYLON.Nullable<string>);
  3939. get tooltipText(): BABYLON.Nullable<string>;
  3940. /**
  3941. * Gets or sets text for the button
  3942. */
  3943. get text(): string;
  3944. set text(value: string);
  3945. /**
  3946. * Gets or sets the image url for the button
  3947. */
  3948. get imageUrl(): string;
  3949. set imageUrl(value: string);
  3950. /**
  3951. * Gets the back material used by this button
  3952. */
  3953. get backMaterial(): FluentMaterial;
  3954. /**
  3955. * Gets the front material used by this button
  3956. */
  3957. get frontMaterial(): FluentMaterial;
  3958. /**
  3959. * Gets the plate material used by this button
  3960. */
  3961. get plateMaterial(): BABYLON.StandardMaterial;
  3962. /**
  3963. * Gets a boolean indicating if this button shares its material with other HolographicButtons
  3964. */
  3965. get shareMaterials(): boolean;
  3966. /**
  3967. * Creates a new button
  3968. * @param name defines the control name
  3969. */
  3970. constructor(name?: string, shareMaterials?: boolean);
  3971. protected _getTypeName(): string;
  3972. private _rebuildContent;
  3973. protected _createNode(scene: BABYLON.Scene): BABYLON.TransformNode;
  3974. protected _applyFacade(facadeTexture: AdvancedDynamicTexture): void;
  3975. private _createBackMaterial;
  3976. private _createFrontMaterial;
  3977. private _createPlateMaterial;
  3978. protected _affectMaterial(mesh: BABYLON.Mesh): void;
  3979. /**
  3980. * Releases all associated resources
  3981. */
  3982. dispose(): void;
  3983. }
  3984. }
  3985. declare module BABYLON.GUI {
  3986. /**
  3987. * Class used to create an interactable object. It's a 3D button using a mesh coming from the current scene
  3988. */
  3989. export class MeshButton3D extends Button3D {
  3990. /** @hidden */
  3991. protected _currentMesh: BABYLON.Mesh;
  3992. /**
  3993. * Creates a new 3D button based on a mesh
  3994. * @param mesh mesh to become a 3D button
  3995. * @param name defines the control name
  3996. */
  3997. constructor(mesh: BABYLON.Mesh, name?: string);
  3998. protected _getTypeName(): string;
  3999. protected _createNode(scene: BABYLON.Scene): BABYLON.TransformNode;
  4000. protected _affectMaterial(mesh: BABYLON.AbstractMesh): void;
  4001. }
  4002. }
  4003. declare module BABYLON.GUI {
  4004. /**
  4005. * Class used to create a container panel deployed on the surface of a plane
  4006. */
  4007. export class PlanePanel extends VolumeBasedPanel {
  4008. protected _mapGridNode(control: Control3D, nodePosition: BABYLON.Vector3): void;
  4009. }
  4010. }
  4011. declare module BABYLON.GUI {
  4012. /**
  4013. * Class used to create a container panel where items get randomized planar mapping
  4014. */
  4015. export class ScatterPanel extends VolumeBasedPanel {
  4016. private _iteration;
  4017. /**
  4018. * Gets or sets the number of iteration to use to scatter the controls (100 by default)
  4019. */
  4020. get iteration(): BABYLON.float;
  4021. set iteration(value: BABYLON.float);
  4022. protected _mapGridNode(control: Control3D, nodePosition: BABYLON.Vector3): void;
  4023. private _scatterMapping;
  4024. protected _finalProcessing(): void;
  4025. }
  4026. }
  4027. declare module BABYLON.GUI {
  4028. /**
  4029. * Class used to create a container panel deployed on the surface of a sphere
  4030. */
  4031. export class SpherePanel extends VolumeBasedPanel {
  4032. private _radius;
  4033. /**
  4034. * Gets or sets the radius of the sphere where to project controls (5 by default)
  4035. */
  4036. get radius(): BABYLON.float;
  4037. set radius(value: BABYLON.float);
  4038. protected _mapGridNode(control: Control3D, nodePosition: BABYLON.Vector3): void;
  4039. private _sphericalMapping;
  4040. }
  4041. }
  4042. declare module BABYLON.GUI {
  4043. /**
  4044. * Class used to create a stack panel in 3D on XY plane
  4045. */
  4046. export class StackPanel3D extends Container3D {
  4047. private _isVertical;
  4048. /**
  4049. * Gets or sets a boolean indicating if the stack panel is vertical or horizontal (horizontal by default)
  4050. */
  4051. get isVertical(): boolean;
  4052. set isVertical(value: boolean);
  4053. /**
  4054. * Gets or sets the distance between elements
  4055. */
  4056. margin: number;
  4057. /**
  4058. * Creates new StackPanel
  4059. * @param isVertical
  4060. */
  4061. constructor(isVertical?: boolean);
  4062. protected _arrangeChildren(): void;
  4063. }
  4064. }