1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557 |
- declare module "babylonjs-gui/2D/valueAndUnit" {
- import { AdvancedDynamicTexture } from "babylonjs-gui/2D/advancedDynamicTexture";
- /**
- * Class used to specific a value and its associated unit
- */
- export class ValueAndUnit {
- /** defines the unit to store */
- unit: number;
- /** defines a boolean indicating if the value can be negative */
- negativeValueAllowed: boolean;
- private _value;
- private _originalUnit;
- /**
- * Gets or sets a value indicating that this value will not scale accordingly with adaptive scaling property
- * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
- */
- ignoreAdaptiveScaling: boolean;
- /**
- * Creates a new ValueAndUnit
- * @param value defines the value to store
- * @param unit defines the unit to store
- * @param negativeValueAllowed defines a boolean indicating if the value can be negative
- */
- constructor(value: number,
- /** defines the unit to store */
- unit?: number,
- /** defines a boolean indicating if the value can be negative */
- negativeValueAllowed?: boolean);
- /** Gets a boolean indicating if the value is a percentage */
- get isPercentage(): boolean;
- /** Gets a boolean indicating if the value is store as pixel */
- get isPixel(): boolean;
- /** Gets direct internal value */
- get internalValue(): number;
- /**
- * Gets value as pixel
- * @param host defines the root host
- * @param refValue defines the reference value for percentages
- * @returns the value as pixel
- */
- getValueInPixel(host: AdvancedDynamicTexture, refValue: number): number;
- /**
- * Update the current value and unit. This should be done cautiously as the GUi won't be marked as dirty with this function.
- * @param value defines the value to store
- * @param unit defines the unit to store
- * @returns the current ValueAndUnit
- */
- updateInPlace(value: number, unit?: number): ValueAndUnit;
- /**
- * Gets the value accordingly to its unit
- * @param host defines the root host
- * @returns the value
- */
- getValue(host: AdvancedDynamicTexture): number;
- /**
- * Gets a string representation of the value
- * @param host defines the root host
- * @param decimals defines an optional number of decimals to display
- * @returns a string
- */
- toString(host: AdvancedDynamicTexture, decimals?: number): string;
- /**
- * Store a value parsed from a string
- * @param source defines the source string
- * @returns true if the value was successfully parsed
- */
- fromString(source: string | number): boolean;
- private static _Regex;
- private static _UNITMODE_PERCENTAGE;
- private static _UNITMODE_PIXEL;
- /** UNITMODE_PERCENTAGE */
- static get UNITMODE_PERCENTAGE(): number;
- /** UNITMODE_PIXEL */
- static get UNITMODE_PIXEL(): number;
- }
- }
- declare module "babylonjs-gui/2D/style" {
- import { Observable } from "babylonjs/Misc/observable";
- import { IDisposable } from "babylonjs/scene";
- import { AdvancedDynamicTexture } from "babylonjs-gui/2D/advancedDynamicTexture";
- import { ValueAndUnit } from "babylonjs-gui/2D/valueAndUnit";
- /**
- * Define a style used by control to automatically setup properties based on a template.
- * Only support font related properties so far
- */
- export class Style implements IDisposable {
- private _fontFamily;
- private _fontStyle;
- private _fontWeight;
- /** @hidden */
- _host: AdvancedDynamicTexture;
- /** @hidden */
- _fontSize: ValueAndUnit;
- /**
- * Observable raised when the style values are changed
- */
- onChangedObservable: Observable<Style>;
- /**
- * Creates a new style object
- * @param host defines the AdvancedDynamicTexture which hosts this style
- */
- constructor(host: AdvancedDynamicTexture);
- /**
- * Gets or sets the font size
- */
- get fontSize(): string | number;
- set fontSize(value: string | number);
- /**
- * Gets or sets the font family
- */
- get fontFamily(): string;
- set fontFamily(value: string);
- /**
- * Gets or sets the font style
- */
- get fontStyle(): string;
- set fontStyle(value: string);
- /** Gets or sets font weight */
- get fontWeight(): string;
- set fontWeight(value: string);
- /** Dispose all associated resources */
- dispose(): void;
- }
- }
- declare module "babylonjs-gui/2D/math2D" {
- import { Nullable } from "babylonjs/types";
- import { Vector2 } from "babylonjs/Maths/math.vector";
- /**
- * Class used to transport Vector2 information for pointer events
- */
- export class Vector2WithInfo extends Vector2 {
- /** defines the current mouse button index */
- buttonIndex: number;
- /**
- * Creates a new Vector2WithInfo
- * @param source defines the vector2 data to transport
- * @param buttonIndex defines the current mouse button index
- */
- constructor(source: Vector2,
- /** defines the current mouse button index */
- buttonIndex?: number);
- }
- /** Class used to provide 2D matrix features */
- export class Matrix2D {
- /** Gets the internal array of 6 floats used to store matrix data */
- m: Float32Array;
- /**
- * Creates a new matrix
- * @param m00 defines value for (0, 0)
- * @param m01 defines value for (0, 1)
- * @param m10 defines value for (1, 0)
- * @param m11 defines value for (1, 1)
- * @param m20 defines value for (2, 0)
- * @param m21 defines value for (2, 1)
- */
- constructor(m00: number, m01: number, m10: number, m11: number, m20: number, m21: number);
- /**
- * Fills the matrix from direct values
- * @param m00 defines value for (0, 0)
- * @param m01 defines value for (0, 1)
- * @param m10 defines value for (1, 0)
- * @param m11 defines value for (1, 1)
- * @param m20 defines value for (2, 0)
- * @param m21 defines value for (2, 1)
- * @returns the current modified matrix
- */
- fromValues(m00: number, m01: number, m10: number, m11: number, m20: number, m21: number): Matrix2D;
- /**
- * Gets matrix determinant
- * @returns the determinant
- */
- determinant(): number;
- /**
- * Inverses the matrix and stores it in a target matrix
- * @param result defines the target matrix
- * @returns the current matrix
- */
- invertToRef(result: Matrix2D): Matrix2D;
- /**
- * Multiplies the current matrix with another one
- * @param other defines the second operand
- * @param result defines the target matrix
- * @returns the current matrix
- */
- multiplyToRef(other: Matrix2D, result: Matrix2D): Matrix2D;
- /**
- * Applies the current matrix to a set of 2 floats and stores the result in a vector2
- * @param x defines the x coordinate to transform
- * @param y defines the x coordinate to transform
- * @param result defines the target vector2
- * @returns the current matrix
- */
- transformCoordinates(x: number, y: number, result: Vector2): Matrix2D;
- /**
- * Creates an identity matrix
- * @returns a new matrix
- */
- static Identity(): Matrix2D;
- /**
- * Creates a translation matrix and stores it in a target matrix
- * @param x defines the x coordinate of the translation
- * @param y defines the y coordinate of the translation
- * @param result defines the target matrix
- */
- static TranslationToRef(x: number, y: number, result: Matrix2D): void;
- /**
- * Creates a scaling matrix and stores it in a target matrix
- * @param x defines the x coordinate of the scaling
- * @param y defines the y coordinate of the scaling
- * @param result defines the target matrix
- */
- static ScalingToRef(x: number, y: number, result: Matrix2D): void;
- /**
- * Creates a rotation matrix and stores it in a target matrix
- * @param angle defines the rotation angle
- * @param result defines the target matrix
- */
- static RotationToRef(angle: number, result: Matrix2D): void;
- private static _TempPreTranslationMatrix;
- private static _TempPostTranslationMatrix;
- private static _TempRotationMatrix;
- private static _TempScalingMatrix;
- private static _TempCompose0;
- private static _TempCompose1;
- private static _TempCompose2;
- /**
- * Composes a matrix from translation, rotation, scaling and parent matrix and stores it in a target matrix
- * @param tx defines the x coordinate of the translation
- * @param ty defines the y coordinate of the translation
- * @param angle defines the rotation angle
- * @param scaleX defines the x coordinate of the scaling
- * @param scaleY defines the y coordinate of the scaling
- * @param parentMatrix defines the parent matrix to multiply by (can be null)
- * @param result defines the target matrix
- */
- static ComposeToRef(tx: number, ty: number, angle: number, scaleX: number, scaleY: number, parentMatrix: Nullable<Matrix2D>, result: Matrix2D): void;
- }
- }
- declare module "babylonjs-gui/2D/measure" {
- import { Matrix2D } from "babylonjs-gui/2D/math2D";
- /**
- * Class used to store 2D control sizes
- */
- export class Measure {
- /** defines left coordinate */
- left: number;
- /** defines top coordinate */
- top: number;
- /** defines width dimension */
- width: number;
- /** defines height dimension */
- height: number;
- /**
- * Creates a new measure
- * @param left defines left coordinate
- * @param top defines top coordinate
- * @param width defines width dimension
- * @param height defines height dimension
- */
- constructor(
- /** defines left coordinate */
- left: number,
- /** defines top coordinate */
- top: number,
- /** defines width dimension */
- width: number,
- /** defines height dimension */
- height: number);
- /**
- * Copy from another measure
- * @param other defines the other measure to copy from
- */
- copyFrom(other: Measure): void;
- /**
- * Copy from a group of 4 floats
- * @param left defines left coordinate
- * @param top defines top coordinate
- * @param width defines width dimension
- * @param height defines height dimension
- */
- copyFromFloats(left: number, top: number, width: number, height: number): void;
- /**
- * Computes the axis aligned bounding box measure for two given measures
- * @param a Input measure
- * @param b Input measure
- * @param result the resulting bounding measure
- */
- static CombineToRef(a: Measure, b: Measure, result: Measure): void;
- /**
- * Computes the axis aligned bounding box of the measure after it is modified by a given transform
- * @param transform the matrix to transform the measure before computing the AABB
- * @param addX number to add to left
- * @param addY number to add to top
- * @param addWidth number to add to width
- * @param addHeight number to add to height
- * @param result the resulting AABB
- */
- addAndTransformToRef(transform: Matrix2D, addX: number, addY: number, addWidth: number, addHeight: number, result: Measure): void;
- /**
- * Computes the axis aligned bounding box of the measure after it is modified by a given transform
- * @param transform the matrix to transform the measure before computing the AABB
- * @param result the resulting AABB
- */
- transformToRef(transform: Matrix2D, result: Measure): void;
- /**
- * Check equality between this measure and another one
- * @param other defines the other measures
- * @returns true if both measures are equals
- */
- isEqualsTo(other: Measure): boolean;
- /**
- * Creates an empty measure
- * @returns a new measure
- */
- static Empty(): Measure;
- }
- }
- declare module "babylonjs-gui/2D/advancedDynamicTexture" {
- import { Nullable } from "babylonjs/types";
- import { Observable } from "babylonjs/Misc/observable";
- import { Vector2, Vector3, Matrix } from "babylonjs/Maths/math.vector";
- import { ClipboardInfo } from "babylonjs/Events/clipboardEvents";
- import { DynamicTexture } from "babylonjs/Materials/Textures/dynamicTexture";
- import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
- import { Layer } from "babylonjs/Layers/layer";
- import { Scene } from "babylonjs/scene";
- import { Container } from "babylonjs-gui/2D/controls/container";
- import { Control } from "babylonjs-gui/2D/controls/control";
- import { Style } from "babylonjs-gui/2D/style";
- import { Viewport } from 'babylonjs/Maths/math.viewport';
- /**
- * Interface used to define a control that can receive focus
- */
- export interface IFocusableControl {
- /**
- * Function called when the control receives the focus
- */
- onFocus(): void;
- /**
- * Function called when the control loses the focus
- */
- onBlur(): void;
- /**
- * Function called to let the control handle keyboard events
- * @param evt defines the current keyboard event
- */
- processKeyboard(evt: KeyboardEvent): void;
- /**
- * Function called to get the list of controls that should not steal the focus from this control
- * @returns an array of controls
- */
- keepsFocusWith(): Nullable<Control[]>;
- }
- /**
- * Class used to create texture to support 2D GUI elements
- * @see https://doc.babylonjs.com/how_to/gui
- */
- export class AdvancedDynamicTexture extends DynamicTexture {
- private _isDirty;
- private _renderObserver;
- private _resizeObserver;
- private _preKeyboardObserver;
- private _pointerMoveObserver;
- private _pointerObserver;
- private _canvasPointerOutObserver;
- private _canvasBlurObserver;
- private _background;
- /** @hidden */
- _rootContainer: Container;
- /** @hidden */
- _lastPickedControl: Control;
- /** @hidden */
- _lastControlOver: {
- [pointerId: number]: Control;
- };
- /** @hidden */
- _lastControlDown: {
- [pointerId: number]: Control;
- };
- /** @hidden */
- _capturingControl: {
- [pointerId: number]: Control;
- };
- /** @hidden */
- _shouldBlockPointer: boolean;
- /** @hidden */
- _layerToDispose: Nullable<Layer>;
- /** @hidden */
- _linkedControls: Control[];
- private _isFullscreen;
- private _fullscreenViewport;
- private _idealWidth;
- private _idealHeight;
- private _useSmallestIdeal;
- private _renderAtIdealSize;
- private _focusedControl;
- private _blockNextFocusCheck;
- private _renderScale;
- private _rootElement;
- private _cursorChanged;
- private _defaultMousePointerId;
- /** @hidden */
- _numLayoutCalls: number;
- /** Gets the number of layout calls made the last time the ADT has been rendered */
- get numLayoutCalls(): number;
- /** @hidden */
- _numRenderCalls: number;
- /** Gets the number of render calls made the last time the ADT has been rendered */
- get numRenderCalls(): number;
- /**
- * Define type to string to ensure compatibility across browsers
- * Safari doesn't support DataTransfer constructor
- */
- private _clipboardData;
- /**
- * Observable event triggered each time an clipboard event is received from the rendering canvas
- */
- onClipboardObservable: Observable<ClipboardInfo>;
- /**
- * Observable event triggered each time a pointer down is intercepted by a control
- */
- onControlPickedObservable: Observable<Control>;
- /**
- * Observable event triggered before layout is evaluated
- */
- onBeginLayoutObservable: Observable<AdvancedDynamicTexture>;
- /**
- * Observable event triggered after the layout was evaluated
- */
- onEndLayoutObservable: Observable<AdvancedDynamicTexture>;
- /**
- * Observable event triggered before the texture is rendered
- */
- onBeginRenderObservable: Observable<AdvancedDynamicTexture>;
- /**
- * Observable event triggered after the texture was rendered
- */
- onEndRenderObservable: Observable<AdvancedDynamicTexture>;
- /**
- * Gets or sets a boolean defining if alpha is stored as premultiplied
- */
- premulAlpha: boolean;
- /**
- * Gets or sets a number used to scale rendering size (2 means that the texture will be twice bigger).
- * Useful when you want more antialiasing
- */
- get renderScale(): number;
- set renderScale(value: number);
- /** Gets or sets the background color */
- get background(): string;
- set background(value: string);
- /**
- * Gets or sets the ideal width used to design controls.
- * The GUI will then rescale everything accordingly
- * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
- */
- get idealWidth(): number;
- set idealWidth(value: number);
- /**
- * Gets or sets the ideal height used to design controls.
- * The GUI will then rescale everything accordingly
- * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
- */
- get idealHeight(): number;
- set idealHeight(value: number);
- /**
- * Gets or sets a boolean indicating if the smallest ideal value must be used if idealWidth and idealHeight are both set
- * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
- */
- get useSmallestIdeal(): boolean;
- set useSmallestIdeal(value: boolean);
- /**
- * Gets or sets a boolean indicating if adaptive scaling must be used
- * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
- */
- get renderAtIdealSize(): boolean;
- set renderAtIdealSize(value: boolean);
- /**
- * Gets the ratio used when in "ideal mode"
- * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
- * */
- get idealRatio(): number;
- /**
- * Gets the underlying layer used to render the texture when in fullscreen mode
- */
- get layer(): Nullable<Layer>;
- /**
- * Gets the root container control
- */
- get rootContainer(): Container;
- /**
- * Returns an array containing the root container.
- * This is mostly used to let the Inspector introspects the ADT
- * @returns an array containing the rootContainer
- */
- getChildren(): Array<Container>;
- /**
- * Will return all controls that are inside this texture
- * @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
- * @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
- * @return all child controls
- */
- getDescendants(directDescendantsOnly?: boolean, predicate?: (control: Control) => boolean): Control[];
- /**
- * Gets or sets the current focused control
- */
- get focusedControl(): Nullable<IFocusableControl>;
- set focusedControl(control: Nullable<IFocusableControl>);
- /**
- * Gets or sets a boolean indicating if the texture must be rendered in background or foreground when in fullscreen mode
- */
- get isForeground(): boolean;
- set isForeground(value: boolean);
- /**
- * Gets or set information about clipboardData
- */
- get clipboardData(): string;
- set clipboardData(value: string);
- /**
- * Creates a new AdvancedDynamicTexture
- * @param name defines the name of the texture
- * @param width defines the width of the texture
- * @param height defines the height of the texture
- * @param scene defines the hosting scene
- * @param generateMipMaps defines a boolean indicating if mipmaps must be generated (false by default)
- * @param samplingMode defines the texture sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
- * @param invertY defines if the texture needs to be inverted on the y axis during loading (true by default)
- */
- constructor(name: string, width: number | undefined, height: number | undefined, scene: Nullable<Scene>, generateMipMaps?: boolean, samplingMode?: number, invertY?: boolean);
- /**
- * Get the current class name of the texture useful for serialization or dynamic coding.
- * @returns "AdvancedDynamicTexture"
- */
- getClassName(): string;
- /**
- * Function used to execute a function on all controls
- * @param func defines the function to execute
- * @param container defines the container where controls belong. If null the root container will be used
- */
- executeOnAllControls(func: (control: Control) => void, container?: Container): void;
- private _useInvalidateRectOptimization;
- /**
- * Gets or sets a boolean indicating if the InvalidateRect optimization should be turned on
- */
- get useInvalidateRectOptimization(): boolean;
- set useInvalidateRectOptimization(value: boolean);
- private _invalidatedRectangle;
- /**
- * Invalidates a rectangle area on the gui texture
- * @param invalidMinX left most position of the rectangle to invalidate in the texture
- * @param invalidMinY top most position of the rectangle to invalidate in the texture
- * @param invalidMaxX right most position of the rectangle to invalidate in the texture
- * @param invalidMaxY bottom most position of the rectangle to invalidate in the texture
- */
- invalidateRect(invalidMinX: number, invalidMinY: number, invalidMaxX: number, invalidMaxY: number): void;
- /**
- * Marks the texture as dirty forcing a complete update
- */
- markAsDirty(): void;
- /**
- * Helper function used to create a new style
- * @returns a new style
- * @see https://doc.babylonjs.com/how_to/gui#styles
- */
- createStyle(): Style;
- /**
- * Adds a new control to the root container
- * @param control defines the control to add
- * @returns the current texture
- */
- addControl(control: Control): AdvancedDynamicTexture;
- /**
- * Removes a control from the root container
- * @param control defines the control to remove
- * @returns the current texture
- */
- removeControl(control: Control): AdvancedDynamicTexture;
- /**
- * Release all resources
- */
- dispose(): void;
- private _onResize;
- /** @hidden */
- _getGlobalViewport(scene: Scene): Viewport;
- /**
- * Get screen coordinates for a vector3
- * @param position defines the position to project
- * @param worldMatrix defines the world matrix to use
- * @returns the projected position
- */
- getProjectedPosition(position: Vector3, worldMatrix: Matrix): Vector2;
- private _checkUpdate;
- private _clearMeasure;
- private _render;
- /** @hidden */
- _changeCursor(cursor: string): void;
- /** @hidden */
- _registerLastControlDown(control: Control, pointerId: number): void;
- private _doPicking;
- /** @hidden */
- _cleanControlAfterRemovalFromList(list: {
- [pointerId: number]: Control;
- }, control: Control): void;
- /** @hidden */
- _cleanControlAfterRemoval(control: Control): void;
- /** Attach to all scene events required to support pointer events */
- attach(): void;
- /** @hidden */
- private onClipboardCopy;
- /** @hidden */
- private onClipboardCut;
- /** @hidden */
- private onClipboardPaste;
- /**
- * Register the clipboard Events onto the canvas
- */
- registerClipboardEvents(): void;
- /**
- * Unregister the clipboard Events from the canvas
- */
- unRegisterClipboardEvents(): void;
- /**
- * Connect the texture to a hosting mesh to enable interactions
- * @param mesh defines the mesh to attach to
- * @param supportPointerMove defines a boolean indicating if pointer move events must be catched as well
- */
- attachToMesh(mesh: AbstractMesh, supportPointerMove?: boolean): void;
- /**
- * Move the focus to a specific control
- * @param control defines the control which will receive the focus
- */
- moveFocusToControl(control: IFocusableControl): void;
- private _manageFocus;
- private _attachToOnPointerOut;
- private _attachToOnBlur;
- /**
- * Creates a new AdvancedDynamicTexture in projected mode (ie. attached to a mesh)
- * @param mesh defines the mesh which will receive the texture
- * @param width defines the texture width (1024 by default)
- * @param height defines the texture height (1024 by default)
- * @param supportPointerMove defines a boolean indicating if the texture must capture move events (true by default)
- * @param onlyAlphaTesting defines a boolean indicating that alpha blending will not be used (only alpha testing) (false by default)
- * @param invertY defines if the texture needs to be inverted on the y axis during loading (true by default)
- * @returns a new AdvancedDynamicTexture
- */
- static CreateForMesh(mesh: AbstractMesh, width?: number, height?: number, supportPointerMove?: boolean, onlyAlphaTesting?: boolean, invertY?: boolean): AdvancedDynamicTexture;
- /**
- * Creates a new AdvancedDynamicTexture in fullscreen mode.
- * In this mode the texture will rely on a layer for its rendering.
- * This allows it to be treated like any other layer.
- * As such, if you have a multi camera setup, you can set the layerMask on the GUI as well.
- * LayerMask is set through advancedTexture.layer.layerMask
- * @param name defines name for the texture
- * @param foreground defines a boolean indicating if the texture must be rendered in foreground (default is true)
- * @param scene defines the hsoting scene
- * @param sampling defines the texture sampling mode (Texture.BILINEAR_SAMPLINGMODE by default)
- * @returns a new AdvancedDynamicTexture
- */
- static CreateFullscreenUI(name: string, foreground?: boolean, scene?: Nullable<Scene>, sampling?: number): AdvancedDynamicTexture;
- }
- }
- declare module "babylonjs-gui/2D/controls/control" {
- import { Nullable } from "babylonjs/types";
- import { Observable } from "babylonjs/Misc/observable";
- import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
- import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
- import { Scene } from "babylonjs/scene";
- import { Container } from "babylonjs-gui/2D/controls/container";
- import { AdvancedDynamicTexture } from "babylonjs-gui/2D/advancedDynamicTexture";
- import { ValueAndUnit } from "babylonjs-gui/2D/valueAndUnit";
- import { Measure } from "babylonjs-gui/2D/measure";
- import { Style } from "babylonjs-gui/2D/style";
- import { Matrix2D, Vector2WithInfo } from "babylonjs-gui/2D/math2D";
- /**
- * Root class used for all 2D controls
- * @see https://doc.babylonjs.com/how_to/gui#controls
- */
- export class Control {
- /** defines the name of the control */
- name?: string | undefined;
- /**
- * Gets or sets a boolean indicating if alpha must be an inherited value (false by default)
- */
- static AllowAlphaInheritance: boolean;
- private _alpha;
- private _alphaSet;
- private _zIndex;
- /** @hidden */
- _host: AdvancedDynamicTexture;
- /** Gets or sets the control parent */
- parent: Nullable<Container>;
- /** @hidden */
- _currentMeasure: Measure;
- private _fontFamily;
- private _fontStyle;
- private _fontWeight;
- private _fontSize;
- private _font;
- /** @hidden */
- _width: ValueAndUnit;
- /** @hidden */
- _height: ValueAndUnit;
- /** @hidden */
- protected _fontOffset: {
- ascent: number;
- height: number;
- descent: number;
- };
- private _color;
- private _style;
- private _styleObserver;
- /** @hidden */
- protected _horizontalAlignment: number;
- /** @hidden */
- protected _verticalAlignment: number;
- /** @hidden */
- protected _isDirty: boolean;
- /** @hidden */
- protected _wasDirty: boolean;
- /** @hidden */
- _tempParentMeasure: Measure;
- /** @hidden */
- _prevCurrentMeasureTransformedIntoGlobalSpace: Measure;
- /** @hidden */
- protected _cachedParentMeasure: Measure;
- private _paddingLeft;
- private _paddingRight;
- private _paddingTop;
- private _paddingBottom;
- /** @hidden */
- _left: ValueAndUnit;
- /** @hidden */
- _top: ValueAndUnit;
- private _scaleX;
- private _scaleY;
- private _rotation;
- private _transformCenterX;
- private _transformCenterY;
- /** @hidden */
- _transformMatrix: Matrix2D;
- /** @hidden */
- protected _invertTransformMatrix: Matrix2D;
- /** @hidden */
- protected _transformedPosition: Vector2;
- private _isMatrixDirty;
- private _cachedOffsetX;
- private _cachedOffsetY;
- private _isVisible;
- private _isHighlighted;
- /** @hidden */
- _linkedMesh: Nullable<AbstractMesh>;
- private _fontSet;
- private _dummyVector2;
- private _downCount;
- private _enterCount;
- private _doNotRender;
- private _downPointerIds;
- protected _isEnabled: boolean;
- protected _disabledColor: string;
- protected _disabledColorItem: string;
- /** @hidden */
- protected _rebuildLayout: boolean;
- /** @hidden */
- _customData: any;
- /** @hidden */
- _isClipped: boolean;
- /** @hidden */
- _automaticSize: boolean;
- /** @hidden */
- _tag: any;
- /**
- * 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
- */
- uniqueId: number;
- /**
- * Gets or sets an object used to store user defined information for the node
- */
- metadata: any;
- /** Gets or sets a boolean indicating if the control can be hit with pointer events */
- isHitTestVisible: boolean;
- /** Gets or sets a boolean indicating if the control can block pointer events */
- isPointerBlocker: boolean;
- /** Gets or sets a boolean indicating if the control can be focusable */
- isFocusInvisible: boolean;
- /**
- * Gets or sets a boolean indicating if the children are clipped to the current control bounds.
- * 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
- */
- clipChildren: boolean;
- /**
- * Gets or sets a boolean indicating that control content must be clipped
- * 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
- */
- clipContent: boolean;
- /**
- * Gets or sets a boolean indicating that the current control should cache its rendering (useful when the control does not change often)
- */
- useBitmapCache: boolean;
- private _cacheData;
- private _shadowOffsetX;
- /** Gets or sets a value indicating the offset to apply on X axis to render the shadow */
- get shadowOffsetX(): number;
- set shadowOffsetX(value: number);
- private _shadowOffsetY;
- /** Gets or sets a value indicating the offset to apply on Y axis to render the shadow */
- get shadowOffsetY(): number;
- set shadowOffsetY(value: number);
- private _shadowBlur;
- /** Gets or sets a value indicating the amount of blur to use to render the shadow */
- get shadowBlur(): number;
- set shadowBlur(value: number);
- private _shadowColor;
- /** Gets or sets a value indicating the color of the shadow (black by default ie. "#000") */
- get shadowColor(): string;
- set shadowColor(value: string);
- /** Gets or sets the cursor to use when the control is hovered */
- hoverCursor: string;
- /** @hidden */
- protected _linkOffsetX: ValueAndUnit;
- /** @hidden */
- protected _linkOffsetY: ValueAndUnit;
- /** Gets the control type name */
- get typeName(): string;
- /**
- * Get the current class name of the control.
- * @returns current class name
- */
- getClassName(): string;
- /**
- * An event triggered when pointer wheel is scrolled
- */
- onWheelObservable: Observable<Vector2>;
- /**
- * An event triggered when the pointer move over the control.
- */
- onPointerMoveObservable: Observable<Vector2>;
- /**
- * An event triggered when the pointer move out of the control.
- */
- onPointerOutObservable: Observable<Control>;
- /**
- * An event triggered when the pointer taps the control
- */
- onPointerDownObservable: Observable<Vector2WithInfo>;
- /**
- * An event triggered when pointer up
- */
- onPointerUpObservable: Observable<Vector2WithInfo>;
- /**
- * An event triggered when a control is clicked on
- */
- onPointerClickObservable: Observable<Vector2WithInfo>;
- /**
- * An event triggered when pointer enters the control
- */
- onPointerEnterObservable: Observable<Control>;
- /**
- * An event triggered when the control is marked as dirty
- */
- onDirtyObservable: Observable<Control>;
- /**
- * An event triggered before drawing the control
- */
- onBeforeDrawObservable: Observable<Control>;
- /**
- * An event triggered after the control was drawn
- */
- onAfterDrawObservable: Observable<Control>;
- /**
- * An event triggered when the control has been disposed
- */
- onDisposeObservable: Observable<Control>;
- /**
- * Get the hosting AdvancedDynamicTexture
- */
- get host(): AdvancedDynamicTexture;
- /** Gets or set information about font offsets (used to render and align text) */
- get fontOffset(): {
- ascent: number;
- height: number;
- descent: number;
- };
- set fontOffset(offset: {
- ascent: number;
- height: number;
- descent: number;
- });
- /** Gets or sets alpha value for the control (1 means opaque and 0 means entirely transparent) */
- get alpha(): number;
- set alpha(value: number);
- /**
- * Gets or sets a boolean indicating that we want to highlight the control (mostly for debugging purpose)
- */
- get isHighlighted(): boolean;
- set isHighlighted(value: boolean);
- /** Gets or sets a value indicating the scale factor on X axis (1 by default)
- * @see https://doc.babylonjs.com/how_to/gui#rotation-and-scaling
- */
- get scaleX(): number;
- set scaleX(value: number);
- /** Gets or sets a value indicating the scale factor on Y axis (1 by default)
- * @see https://doc.babylonjs.com/how_to/gui#rotation-and-scaling
- */
- get scaleY(): number;
- set scaleY(value: number);
- /** Gets or sets the rotation angle (0 by default)
- * @see https://doc.babylonjs.com/how_to/gui#rotation-and-scaling
- */
- get rotation(): number;
- set rotation(value: number);
- /** Gets or sets the transformation center on Y axis (0 by default)
- * @see https://doc.babylonjs.com/how_to/gui#rotation-and-scaling
- */
- get transformCenterY(): number;
- set transformCenterY(value: number);
- /** Gets or sets the transformation center on X axis (0 by default)
- * @see https://doc.babylonjs.com/how_to/gui#rotation-and-scaling
- */
- get transformCenterX(): number;
- set transformCenterX(value: number);
- /**
- * Gets or sets the horizontal alignment
- * @see https://doc.babylonjs.com/how_to/gui#alignments
- */
- get horizontalAlignment(): number;
- set horizontalAlignment(value: number);
- /**
- * Gets or sets the vertical alignment
- * @see https://doc.babylonjs.com/how_to/gui#alignments
- */
- get verticalAlignment(): number;
- set verticalAlignment(value: number);
- /**
- * Gets or sets a fixed ratio for this control.
- * When different from 0, the ratio is used to compute the "second" dimension.
- * The first dimension used in the computation is the last one set (by setting width / widthInPixels or height / heightInPixels), and the
- * second dimension is computed as first dimension * fixedRatio
- */
- fixedRatio: number;
- private _fixedRatioMasterIsWidth;
- /**
- * Gets or sets control width
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get width(): string | number;
- set width(value: string | number);
- /**
- * Gets or sets the control width in pixel
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get widthInPixels(): number;
- set widthInPixels(value: number);
- /**
- * Gets or sets control height
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get height(): string | number;
- set height(value: string | number);
- /**
- * Gets or sets control height in pixel
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get heightInPixels(): number;
- set heightInPixels(value: number);
- /** Gets or set font family */
- get fontFamily(): string;
- set fontFamily(value: string);
- /** Gets or sets font style */
- get fontStyle(): string;
- set fontStyle(value: string);
- /** Gets or sets font weight */
- get fontWeight(): string;
- set fontWeight(value: string);
- /**
- * Gets or sets style
- * @see https://doc.babylonjs.com/how_to/gui#styles
- */
- get style(): Nullable<Style>;
- set style(value: Nullable<Style>);
- /** @hidden */
- get _isFontSizeInPercentage(): boolean;
- /** Gets or sets font size in pixels */
- get fontSizeInPixels(): number;
- set fontSizeInPixels(value: number);
- /** Gets or sets font size */
- get fontSize(): string | number;
- set fontSize(value: string | number);
- /** Gets or sets foreground color */
- get color(): string;
- set color(value: string);
- /** Gets or sets z index which is used to reorder controls on the z axis */
- get zIndex(): number;
- set zIndex(value: number);
- /** Gets or sets a boolean indicating if the control can be rendered */
- get notRenderable(): boolean;
- set notRenderable(value: boolean);
- /** Gets or sets a boolean indicating if the control is visible */
- get isVisible(): boolean;
- set isVisible(value: boolean);
- /** Gets a boolean indicating that the control needs to update its rendering */
- get isDirty(): boolean;
- /**
- * Gets the current linked mesh (or null if none)
- */
- get linkedMesh(): Nullable<AbstractMesh>;
- /**
- * Gets or sets a value indicating the padding to use on the left of the control
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get paddingLeft(): string | number;
- set paddingLeft(value: string | number);
- /**
- * Gets or sets a value indicating the padding in pixels to use on the left of the control
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get paddingLeftInPixels(): number;
- set paddingLeftInPixels(value: number);
- /**
- * Gets or sets a value indicating the padding to use on the right of the control
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get paddingRight(): string | number;
- set paddingRight(value: string | number);
- /**
- * Gets or sets a value indicating the padding in pixels to use on the right of the control
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get paddingRightInPixels(): number;
- set paddingRightInPixels(value: number);
- /**
- * Gets or sets a value indicating the padding to use on the top of the control
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get paddingTop(): string | number;
- set paddingTop(value: string | number);
- /**
- * Gets or sets a value indicating the padding in pixels to use on the top of the control
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get paddingTopInPixels(): number;
- set paddingTopInPixels(value: number);
- /**
- * Gets or sets a value indicating the padding to use on the bottom of the control
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get paddingBottom(): string | number;
- set paddingBottom(value: string | number);
- /**
- * Gets or sets a value indicating the padding in pixels to use on the bottom of the control
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get paddingBottomInPixels(): number;
- set paddingBottomInPixels(value: number);
- /**
- * Gets or sets a value indicating the left coordinate of the control
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get left(): string | number;
- set left(value: string | number);
- /**
- * Gets or sets a value indicating the left coordinate in pixels of the control
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get leftInPixels(): number;
- set leftInPixels(value: number);
- /**
- * Gets or sets a value indicating the top coordinate of the control
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get top(): string | number;
- set top(value: string | number);
- /**
- * Gets or sets a value indicating the top coordinate in pixels of the control
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get topInPixels(): number;
- set topInPixels(value: number);
- /**
- * Gets or sets a value indicating the offset on X axis to the linked mesh
- * @see https://doc.babylonjs.com/how_to/gui#tracking-positions
- */
- get linkOffsetX(): string | number;
- set linkOffsetX(value: string | number);
- /**
- * Gets or sets a value indicating the offset in pixels on X axis to the linked mesh
- * @see https://doc.babylonjs.com/how_to/gui#tracking-positions
- */
- get linkOffsetXInPixels(): number;
- set linkOffsetXInPixels(value: number);
- /**
- * Gets or sets a value indicating the offset on Y axis to the linked mesh
- * @see https://doc.babylonjs.com/how_to/gui#tracking-positions
- */
- get linkOffsetY(): string | number;
- set linkOffsetY(value: string | number);
- /**
- * Gets or sets a value indicating the offset in pixels on Y axis to the linked mesh
- * @see https://doc.babylonjs.com/how_to/gui#tracking-positions
- */
- get linkOffsetYInPixels(): number;
- set linkOffsetYInPixels(value: number);
- /** Gets the center coordinate on X axis */
- get centerX(): number;
- /** Gets the center coordinate on Y axis */
- get centerY(): number;
- /** Gets or sets if control is Enabled*/
- get isEnabled(): boolean;
- set isEnabled(value: boolean);
- /** Gets or sets background color of control if it's disabled*/
- get disabledColor(): string;
- set disabledColor(value: string);
- /** Gets or sets front color of control if it's disabled*/
- get disabledColorItem(): string;
- set disabledColorItem(value: string);
- /**
- * Creates a new control
- * @param name defines the name of the control
- */
- constructor(
- /** defines the name of the control */
- name?: string | undefined);
- /** @hidden */
- protected _getTypeName(): string;
- /**
- * Gets the first ascendant in the hierarchy of the given type
- * @param className defines the required type
- * @returns the ascendant or null if not found
- */
- getAscendantOfClass(className: string): Nullable<Control>;
- /** @hidden */
- _resetFontCache(): void;
- /**
- * Determines if a container is an ascendant of the current control
- * @param container defines the container to look for
- * @returns true if the container is one of the ascendant of the control
- */
- isAscendant(container: Control): boolean;
- /**
- * Gets coordinates in local control space
- * @param globalCoordinates defines the coordinates to transform
- * @returns the new coordinates in local space
- */
- getLocalCoordinates(globalCoordinates: Vector2): Vector2;
- /**
- * Gets coordinates in local control space
- * @param globalCoordinates defines the coordinates to transform
- * @param result defines the target vector2 where to store the result
- * @returns the current control
- */
- getLocalCoordinatesToRef(globalCoordinates: Vector2, result: Vector2): Control;
- /**
- * Gets coordinates in parent local control space
- * @param globalCoordinates defines the coordinates to transform
- * @returns the new coordinates in parent local space
- */
- getParentLocalCoordinates(globalCoordinates: Vector2): Vector2;
- /**
- * Move the current control to a vector3 position projected onto the screen.
- * @param position defines the target position
- * @param scene defines the hosting scene
- */
- moveToVector3(position: Vector3, scene: Scene): void;
- /**
- * Will store all controls that have this control as ascendant in a given array
- * @param results defines the array where to store the descendants
- * @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
- * @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
- */
- getDescendantsToRef(results: Control[], directDescendantsOnly?: boolean, predicate?: (control: Control) => boolean): void;
- /**
- * Will return all controls that have this control as ascendant
- * @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
- * @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
- * @return all child controls
- */
- getDescendants(directDescendantsOnly?: boolean, predicate?: (control: Control) => boolean): Control[];
- /**
- * Link current control with a target mesh
- * @param mesh defines the mesh to link with
- * @see https://doc.babylonjs.com/how_to/gui#tracking-positions
- */
- linkWithMesh(mesh: Nullable<AbstractMesh>): void;
- /** @hidden */
- _moveToProjectedPosition(projectedPosition: Vector3): void;
- /** @hidden */
- _offsetLeft(offset: number): void;
- /** @hidden */
- _offsetTop(offset: number): void;
- /** @hidden */
- _markMatrixAsDirty(): void;
- /** @hidden */
- _flagDescendantsAsMatrixDirty(): void;
- /** @hidden */
- _intersectsRect(rect: Measure): boolean;
- /** @hidden */
- protected invalidateRect(): void;
- /** @hidden */
- _markAsDirty(force?: boolean): void;
- /** @hidden */
- _markAllAsDirty(): void;
- /** @hidden */
- _link(host: AdvancedDynamicTexture): void;
- /** @hidden */
- protected _transform(context?: CanvasRenderingContext2D): void;
- /** @hidden */
- _renderHighlight(context: CanvasRenderingContext2D): void;
- /** @hidden */
- _renderHighlightSpecific(context: CanvasRenderingContext2D): void;
- /** @hidden */
- protected _applyStates(context: CanvasRenderingContext2D): void;
- /** @hidden */
- _layout(parentMeasure: Measure, context: CanvasRenderingContext2D): boolean;
- /** @hidden */
- protected _processMeasures(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- protected _evaluateClippingState(parentMeasure: Measure): void;
- /** @hidden */
- _measure(): void;
- /** @hidden */
- protected _computeAlignment(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- /** @hidden */
- protected _preMeasure(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- /** @hidden */
- protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- /** @hidden */
- protected _clipForChildren(context: CanvasRenderingContext2D): void;
- private static _ClipMeasure;
- private _tmpMeasureA;
- private _clip;
- /** @hidden */
- _render(context: CanvasRenderingContext2D, invalidatedRectangle?: Nullable<Measure>): boolean;
- /** @hidden */
- _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: Nullable<Measure>): void;
- /**
- * Tests if a given coordinates belong to the current control
- * @param x defines x coordinate to test
- * @param y defines y coordinate to test
- * @returns true if the coordinates are inside the control
- */
- contains(x: number, y: number): boolean;
- /** @hidden */
- _processPicking(x: number, y: number, type: number, pointerId: number, buttonIndex: number, deltaX?: number, deltaY?: number): boolean;
- /** @hidden */
- _onPointerMove(target: Control, coordinates: Vector2, pointerId: number): void;
- /** @hidden */
- _onPointerEnter(target: Control): boolean;
- /** @hidden */
- _onPointerOut(target: Control, force?: boolean): void;
- /** @hidden */
- _onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
- /** @hidden */
- _onPointerUp(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean): void;
- /** @hidden */
- _forcePointerUp(pointerId?: Nullable<number>): void;
- /** @hidden */
- _onWheelScroll(deltaX?: number, deltaY?: number): void;
- /** @hidden */
- _onCanvasBlur(): void;
- /** @hidden */
- _processObservables(type: number, x: number, y: number, pointerId: number, buttonIndex: number, deltaX?: number, deltaY?: number): boolean;
- private _prepareFont;
- /** Releases associated resources */
- dispose(): void;
- private static _HORIZONTAL_ALIGNMENT_LEFT;
- private static _HORIZONTAL_ALIGNMENT_RIGHT;
- private static _HORIZONTAL_ALIGNMENT_CENTER;
- private static _VERTICAL_ALIGNMENT_TOP;
- private static _VERTICAL_ALIGNMENT_BOTTOM;
- private static _VERTICAL_ALIGNMENT_CENTER;
- /** HORIZONTAL_ALIGNMENT_LEFT */
- static get HORIZONTAL_ALIGNMENT_LEFT(): number;
- /** HORIZONTAL_ALIGNMENT_RIGHT */
- static get HORIZONTAL_ALIGNMENT_RIGHT(): number;
- /** HORIZONTAL_ALIGNMENT_CENTER */
- static get HORIZONTAL_ALIGNMENT_CENTER(): number;
- /** VERTICAL_ALIGNMENT_TOP */
- static get VERTICAL_ALIGNMENT_TOP(): number;
- /** VERTICAL_ALIGNMENT_BOTTOM */
- static get VERTICAL_ALIGNMENT_BOTTOM(): number;
- /** VERTICAL_ALIGNMENT_CENTER */
- static get VERTICAL_ALIGNMENT_CENTER(): number;
- private static _FontHeightSizes;
- /** @hidden */
- static _GetFontOffset(font: string): {
- ascent: number;
- height: number;
- descent: number;
- };
- /**
- * Creates a stack panel that can be used to render headers
- * @param control defines the control to associate with the header
- * @param text defines the text of the header
- * @param size defines the size of the header
- * @param options defines options used to configure the header
- * @returns a new StackPanel
- * @ignore
- * @hidden
- */
- static AddHeader: (control: Control, text: string, size: string | number, options: {
- isHorizontal: boolean;
- controlFirst: boolean;
- }) => any;
- /** @hidden */
- protected static drawEllipse(x: number, y: number, width: number, height: number, context: CanvasRenderingContext2D): void;
- }
- }
- declare module "babylonjs-gui/2D/controls/container" {
- import { Nullable } from "babylonjs/types";
- import { Control } from "babylonjs-gui/2D/controls/control";
- import { Measure } from "babylonjs-gui/2D/measure";
- import { AdvancedDynamicTexture } from "babylonjs-gui/2D/advancedDynamicTexture";
- /**
- * Root class for 2D containers
- * @see https://doc.babylonjs.com/how_to/gui#containers
- */
- export class Container extends Control {
- name?: string | undefined;
- /** @hidden */
- _children: Control[];
- /** @hidden */
- protected _measureForChildren: Measure;
- /** @hidden */
- protected _background: string;
- /** @hidden */
- protected _adaptWidthToChildren: boolean;
- /** @hidden */
- protected _adaptHeightToChildren: boolean;
- /**
- * Gets or sets a boolean indicating that layout cycle errors should be displayed on the console
- */
- logLayoutCycleErrors: boolean;
- /**
- * Gets or sets the number of layout cycles (a change involved by a control while evaluating the layout) allowed
- */
- maxLayoutCycle: number;
- /** Gets or sets a boolean indicating if the container should try to adapt to its children height */
- get adaptHeightToChildren(): boolean;
- set adaptHeightToChildren(value: boolean);
- /** Gets or sets a boolean indicating if the container should try to adapt to its children width */
- get adaptWidthToChildren(): boolean;
- set adaptWidthToChildren(value: boolean);
- /** Gets or sets background color */
- get background(): string;
- set background(value: string);
- /** Gets the list of children */
- get children(): Control[];
- /**
- * Creates a new Container
- * @param name defines the name of the container
- */
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- _flagDescendantsAsMatrixDirty(): void;
- /**
- * Gets a child using its name
- * @param name defines the child name to look for
- * @returns the child control if found
- */
- getChildByName(name: string): Nullable<Control>;
- /**
- * Gets a child using its type and its name
- * @param name defines the child name to look for
- * @param type defines the child type to look for
- * @returns the child control if found
- */
- getChildByType(name: string, type: string): Nullable<Control>;
- /**
- * Search for a specific control in children
- * @param control defines the control to look for
- * @returns true if the control is in child list
- */
- containsControl(control: Control): boolean;
- /**
- * Adds a new control to the current container
- * @param control defines the control to add
- * @returns the current container
- */
- addControl(control: Nullable<Control>): Container;
- /**
- * Removes all controls from the current container
- * @returns the current container
- */
- clearControls(): Container;
- /**
- * Removes a control from the current container
- * @param control defines the control to remove
- * @returns the current container
- */
- removeControl(control: Control): Container;
- /** @hidden */
- _reOrderControl(control: Control): void;
- /** @hidden */
- _offsetLeft(offset: number): void;
- /** @hidden */
- _offsetTop(offset: number): void;
- /** @hidden */
- _markAllAsDirty(): void;
- /** @hidden */
- protected _localDraw(context: CanvasRenderingContext2D): void;
- /** @hidden */
- _link(host: AdvancedDynamicTexture): void;
- /** @hidden */
- protected _beforeLayout(): void;
- /** @hidden */
- protected _processMeasures(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- /** @hidden */
- _layout(parentMeasure: Measure, context: CanvasRenderingContext2D): boolean;
- protected _postMeasure(): void;
- /** @hidden */
- _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: Measure): void;
- getDescendantsToRef(results: Control[], directDescendantsOnly?: boolean, predicate?: (control: Control) => boolean): void;
- /** @hidden */
- _processPicking(x: number, y: number, type: number, pointerId: number, buttonIndex: number, deltaX?: number, deltaY?: number): boolean;
- /** @hidden */
- protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- /** Releases associated resources */
- dispose(): void;
- }
- }
- declare module "babylonjs-gui/2D/controls/rectangle" {
- import { Container } from "babylonjs-gui/2D/controls/container";
- import { Measure } from "babylonjs-gui/2D/measure";
- /** Class used to create rectangle container */
- export class Rectangle extends Container {
- name?: string | undefined;
- private _thickness;
- private _cornerRadius;
- /** Gets or sets border thickness */
- get thickness(): number;
- set thickness(value: number);
- /** Gets or sets the corner radius angle */
- get cornerRadius(): number;
- set cornerRadius(value: number);
- /**
- * Creates a new Rectangle
- * @param name defines the control name
- */
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- protected _localDraw(context: CanvasRenderingContext2D): void;
- protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- private _drawRoundedRect;
- protected _clipForChildren(context: CanvasRenderingContext2D): void;
- }
- }
- declare module "babylonjs-gui/2D/controls/textBlock" {
- import { Observable } from "babylonjs/Misc/observable";
- import { Measure } from "babylonjs-gui/2D/measure";
- import { Control } from "babylonjs-gui/2D/controls/control";
- import { Nullable } from "babylonjs/types";
- /**
- * Enum that determines the text-wrapping mode to use.
- */
- export enum TextWrapping {
- /**
- * Clip the text when it's larger than Control.width; this is the default mode.
- */
- Clip = 0,
- /**
- * Wrap the text word-wise, i.e. try to add line-breaks at word boundary to fit within Control.width.
- */
- WordWrap = 1,
- /**
- * Ellipsize the text, i.e. shrink with trailing … when text is larger than Control.width.
- */
- Ellipsis = 2
- }
- /**
- * Class used to create text block control
- */
- export class TextBlock extends Control {
- /**
- * Defines the name of the control
- */
- name?: string | undefined;
- private _text;
- private _textWrapping;
- private _textHorizontalAlignment;
- private _textVerticalAlignment;
- private _lines;
- private _resizeToFit;
- private _lineSpacing;
- private _outlineWidth;
- private _outlineColor;
- private _underline;
- private _lineThrough;
- /**
- * An event triggered after the text is changed
- */
- onTextChangedObservable: Observable<TextBlock>;
- /**
- * An event triggered after the text was broken up into lines
- */
- onLinesReadyObservable: Observable<TextBlock>;
- /**
- * Function used to split a string into words. By default, a string is split at each space character found
- */
- wordSplittingFunction: Nullable<(line: string) => string[]>;
- /**
- * Return the line list (you may need to use the onLinesReadyObservable to make sure the list is ready)
- */
- get lines(): any[];
- /**
- * Gets or sets an boolean indicating that the TextBlock will be resized to fit container
- */
- get resizeToFit(): boolean;
- /**
- * Gets or sets an boolean indicating that the TextBlock will be resized to fit container
- */
- set resizeToFit(value: boolean);
- /**
- * Gets or sets a boolean indicating if text must be wrapped
- */
- get textWrapping(): TextWrapping | boolean;
- /**
- * Gets or sets a boolean indicating if text must be wrapped
- */
- set textWrapping(value: TextWrapping | boolean);
- /**
- * Gets or sets text to display
- */
- get text(): string;
- /**
- * Gets or sets text to display
- */
- set text(value: string);
- /**
- * Gets or sets text horizontal alignment (BABYLON.GUI.Control.HORIZONTAL_ALIGNMENT_CENTER by default)
- */
- get textHorizontalAlignment(): number;
- /**
- * Gets or sets text horizontal alignment (BABYLON.GUI.Control.HORIZONTAL_ALIGNMENT_CENTER by default)
- */
- set textHorizontalAlignment(value: number);
- /**
- * Gets or sets text vertical alignment (BABYLON.GUI.Control.VERTICAL_ALIGNMENT_CENTER by default)
- */
- get textVerticalAlignment(): number;
- /**
- * Gets or sets text vertical alignment (BABYLON.GUI.Control.VERTICAL_ALIGNMENT_CENTER by default)
- */
- set textVerticalAlignment(value: number);
- /**
- * Gets or sets line spacing value
- */
- set lineSpacing(value: string | number);
- /**
- * Gets or sets line spacing value
- */
- get lineSpacing(): string | number;
- /**
- * Gets or sets outlineWidth of the text to display
- */
- get outlineWidth(): number;
- /**
- * Gets or sets outlineWidth of the text to display
- */
- set outlineWidth(value: number);
- /**
- * Gets or sets a boolean indicating that text must have underline
- */
- get underline(): boolean;
- /**
- * Gets or sets a boolean indicating that text must have underline
- */
- set underline(value: boolean);
- /**
- * Gets or sets an boolean indicating that text must be crossed out
- */
- get lineThrough(): boolean;
- /**
- * Gets or sets an boolean indicating that text must be crossed out
- */
- set lineThrough(value: boolean);
- /**
- * Gets or sets outlineColor of the text to display
- */
- get outlineColor(): string;
- /**
- * Gets or sets outlineColor of the text to display
- */
- set outlineColor(value: string);
- /**
- * Creates a new TextBlock object
- * @param name defines the name of the control
- * @param text defines the text to display (emptry string by default)
- */
- constructor(
- /**
- * Defines the name of the control
- */
- name?: string | undefined, text?: string);
- protected _getTypeName(): string;
- protected _processMeasures(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- private _drawText;
- /** @hidden */
- _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: Nullable<Measure>): void;
- protected _applyStates(context: CanvasRenderingContext2D): void;
- protected _breakLines(refWidth: number, context: CanvasRenderingContext2D): object[];
- protected _parseLine(line: string | undefined, context: CanvasRenderingContext2D): object;
- protected _parseLineEllipsis(line: string | undefined, width: number, context: CanvasRenderingContext2D): object;
- protected _parseLineWordWrap(line: string | undefined, width: number, context: CanvasRenderingContext2D): object[];
- protected _renderLines(context: CanvasRenderingContext2D): void;
- /**
- * Given a width constraint applied on the text block, find the expected height
- * @returns expected height
- */
- computeExpectedHeight(): number;
- dispose(): void;
- }
- }
- declare module "babylonjs-gui/2D/controls/image" {
- import { Nullable } from "babylonjs/types";
- import { Observable } from "babylonjs/Misc/observable";
- import { Control } from "babylonjs-gui/2D/controls/control";
- import { Measure } from "babylonjs-gui/2D/measure";
- /**
- * Class used to create 2D images
- */
- export class Image extends Control {
- name?: string | undefined;
- private _workingCanvas;
- private _domImage;
- private _imageWidth;
- private _imageHeight;
- private _loaded;
- private _stretch;
- private _source;
- private _autoScale;
- private _sourceLeft;
- private _sourceTop;
- private _sourceWidth;
- private _sourceHeight;
- private _svgAttributesComputationCompleted;
- private _isSVG;
- private _cellWidth;
- private _cellHeight;
- private _cellId;
- private _populateNinePatchSlicesFromImage;
- private _sliceLeft;
- private _sliceRight;
- private _sliceTop;
- private _sliceBottom;
- private _detectPointerOnOpaqueOnly;
- private _imageDataCache;
- /**
- * Observable notified when the content is loaded
- */
- onImageLoadedObservable: Observable<Image>;
- /**
- * Observable notified when _sourceLeft, _sourceTop, _sourceWidth and _sourceHeight are computed
- */
- onSVGAttributesComputedObservable: Observable<Image>;
- /**
- * Gets a boolean indicating that the content is loaded
- */
- get isLoaded(): boolean;
- /**
- * Gets or sets a boolean indicating if nine patch slices (left, top, right, bottom) should be read from image data
- */
- get populateNinePatchSlicesFromImage(): boolean;
- set populateNinePatchSlicesFromImage(value: boolean);
- /**
- * Gets or sets a boolean indicating if pointers should only be validated on pixels with alpha > 0.
- * Beware using this as this will comsume more memory as the image has to be stored twice
- */
- get detectPointerOnOpaqueOnly(): boolean;
- set detectPointerOnOpaqueOnly(value: boolean);
- /**
- * Gets or sets the left value for slicing (9-patch)
- */
- get sliceLeft(): number;
- set sliceLeft(value: number);
- /**
- * Gets or sets the right value for slicing (9-patch)
- */
- get sliceRight(): number;
- set sliceRight(value: number);
- /**
- * Gets or sets the top value for slicing (9-patch)
- */
- get sliceTop(): number;
- set sliceTop(value: number);
- /**
- * Gets or sets the bottom value for slicing (9-patch)
- */
- get sliceBottom(): number;
- set sliceBottom(value: number);
- /**
- * Gets or sets the left coordinate in the source image
- */
- get sourceLeft(): number;
- set sourceLeft(value: number);
- /**
- * Gets or sets the top coordinate in the source image
- */
- get sourceTop(): number;
- set sourceTop(value: number);
- /**
- * Gets or sets the width to capture in the source image
- */
- get sourceWidth(): number;
- set sourceWidth(value: number);
- /**
- * Gets or sets the height to capture in the source image
- */
- get sourceHeight(): number;
- set sourceHeight(value: number);
- /** Indicates if the format of the image is SVG */
- get isSVG(): boolean;
- /** Gets the status of the SVG attributes computation (sourceLeft, sourceTop, sourceWidth, sourceHeight) */
- get svgAttributesComputationCompleted(): boolean;
- /**
- * Gets or sets a boolean indicating if the image can force its container to adapt its size
- * @see https://doc.babylonjs.com/how_to/gui#image
- */
- get autoScale(): boolean;
- set autoScale(value: boolean);
- /** Gets or sets the streching mode used by the image */
- get stretch(): number;
- set stretch(value: number);
- /** @hidden */
- _rotate90(n: number, preserveProperties?: boolean): Image;
- private _handleRotationForSVGImage;
- private _rotate90SourceProperties;
- /**
- * Gets or sets the internal DOM image used to render the control
- */
- set domImage(value: HTMLImageElement);
- get domImage(): HTMLImageElement;
- private _onImageLoaded;
- private _extractNinePatchSliceDataFromImage;
- /**
- * Gets or sets image source url
- */
- set source(value: Nullable<string>);
- /**
- * Checks for svg document with icon id present
- */
- private _svgCheck;
- /**
- * Sets sourceLeft, sourceTop, sourceWidth, sourceHeight automatically
- * given external svg file and icon id
- */
- private _getSVGAttribs;
- /**
- * Gets or sets the cell width to use when animation sheet is enabled
- * @see https://doc.babylonjs.com/how_to/gui#image
- */
- get cellWidth(): number;
- set cellWidth(value: number);
- /**
- * Gets or sets the cell height to use when animation sheet is enabled
- * @see https://doc.babylonjs.com/how_to/gui#image
- */
- get cellHeight(): number;
- set cellHeight(value: number);
- /**
- * Gets or sets the cell id to use (this will turn on the animation sheet mode)
- * @see https://doc.babylonjs.com/how_to/gui#image
- */
- get cellId(): number;
- set cellId(value: number);
- /**
- * Creates a new Image
- * @param name defines the control name
- * @param url defines the image url
- */
- constructor(name?: string | undefined, url?: Nullable<string>);
- /**
- * Tests if a given coordinates belong to the current control
- * @param x defines x coordinate to test
- * @param y defines y coordinate to test
- * @returns true if the coordinates are inside the control
- */
- contains(x: number, y: number): boolean;
- protected _getTypeName(): string;
- /** Force the control to synchronize with its content */
- synchronizeSizeWithContent(): void;
- protected _processMeasures(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- private _prepareWorkingCanvasForOpaqueDetection;
- private _drawImage;
- _draw(context: CanvasRenderingContext2D): void;
- private _renderCornerPatch;
- private _renderNinePatch;
- dispose(): void;
- /** STRETCH_NONE */
- static readonly STRETCH_NONE: number;
- /** STRETCH_FILL */
- static readonly STRETCH_FILL: number;
- /** STRETCH_UNIFORM */
- static readonly STRETCH_UNIFORM: number;
- /** STRETCH_EXTEND */
- static readonly STRETCH_EXTEND: number;
- /** NINE_PATCH */
- static readonly STRETCH_NINE_PATCH: number;
- }
- }
- declare module "babylonjs-gui/2D/controls/button" {
- import { Nullable } from "babylonjs/types";
- import { Vector2 } from "babylonjs/Maths/math.vector";
- import { Rectangle } from "babylonjs-gui/2D/controls/rectangle";
- import { Control } from "babylonjs-gui/2D/controls/control";
- import { TextBlock } from "babylonjs-gui/2D/controls/textBlock";
- import { Image } from "babylonjs-gui/2D/controls/image";
- /**
- * Class used to create 2D buttons
- */
- export class Button extends Rectangle {
- name?: string | undefined;
- /**
- * Function called to generate a pointer enter animation
- */
- pointerEnterAnimation: () => void;
- /**
- * Function called to generate a pointer out animation
- */
- pointerOutAnimation: () => void;
- /**
- * Function called to generate a pointer down animation
- */
- pointerDownAnimation: () => void;
- /**
- * Function called to generate a pointer up animation
- */
- pointerUpAnimation: () => void;
- /**
- * Gets or sets a boolean indicating that the button will let internal controls handle picking instead of doing it directly using its bounding info
- */
- delegatePickingToChildren: boolean;
- private _image;
- /**
- * Returns the image part of the button (if any)
- */
- get image(): Nullable<Image>;
- private _textBlock;
- /**
- * Returns the image part of the button (if any)
- */
- get textBlock(): Nullable<TextBlock>;
- /**
- * Creates a new Button
- * @param name defines the name of the button
- */
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- /** @hidden */
- _processPicking(x: number, y: number, type: number, pointerId: number, buttonIndex: number, deltaX?: number, deltaY?: number): boolean;
- /** @hidden */
- _onPointerEnter(target: Control): boolean;
- /** @hidden */
- _onPointerOut(target: Control, force?: boolean): void;
- /** @hidden */
- _onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
- /** @hidden */
- _onPointerUp(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean): void;
- /**
- * Creates a new button made with an image and a text
- * @param name defines the name of the button
- * @param text defines the text of the button
- * @param imageUrl defines the url of the image
- * @returns a new Button
- */
- static CreateImageButton(name: string, text: string, imageUrl: string): Button;
- /**
- * Creates a new button made with an image
- * @param name defines the name of the button
- * @param imageUrl defines the url of the image
- * @returns a new Button
- */
- static CreateImageOnlyButton(name: string, imageUrl: string): Button;
- /**
- * Creates a new button made with a text
- * @param name defines the name of the button
- * @param text defines the text of the button
- * @returns a new Button
- */
- static CreateSimpleButton(name: string, text: string): Button;
- /**
- * Creates a new button made with an image and a centered text
- * @param name defines the name of the button
- * @param text defines the text of the button
- * @param imageUrl defines the url of the image
- * @returns a new Button
- */
- static CreateImageWithCenterTextButton(name: string, text: string, imageUrl: string): Button;
- }
- }
- declare module "babylonjs-gui/2D/controls/stackPanel" {
- import { Container } from "babylonjs-gui/2D/controls/container";
- import { Measure } from "babylonjs-gui/2D/measure";
- /**
- * Class used to create a 2D stack panel container
- */
- export class StackPanel extends Container {
- name?: string | undefined;
- private _isVertical;
- private _manualWidth;
- private _manualHeight;
- private _doNotTrackManualChanges;
- /**
- * Gets or sets a boolean indicating that layou warnings should be ignored
- */
- ignoreLayoutWarnings: boolean;
- /** Gets or sets a boolean indicating if the stack panel is vertical or horizontal*/
- get isVertical(): boolean;
- set isVertical(value: boolean);
- /**
- * Gets or sets panel width.
- * This value should not be set when in horizontal mode as it will be computed automatically
- */
- set width(value: string | number);
- get width(): string | number;
- /**
- * Gets or sets panel height.
- * This value should not be set when in vertical mode as it will be computed automatically
- */
- set height(value: string | number);
- get height(): string | number;
- /**
- * Creates a new StackPanel
- * @param name defines control name
- */
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- /** @hidden */
- protected _preMeasure(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- protected _postMeasure(): void;
- }
- }
- declare module "babylonjs-gui/2D/controls/checkbox" {
- import { Observable } from "babylonjs/Misc/observable";
- import { Vector2 } from "babylonjs/Maths/math.vector";
- import { Control } from "babylonjs-gui/2D/controls/control";
- import { StackPanel } from "babylonjs-gui/2D/controls/stackPanel";
- import { Nullable } from 'babylonjs/types';
- import { Measure } from "babylonjs-gui/2D/measure";
- /**
- * Class used to represent a 2D checkbox
- */
- export class Checkbox extends Control {
- name?: string | undefined;
- private _isChecked;
- private _background;
- private _checkSizeRatio;
- private _thickness;
- /** Gets or sets border thickness */
- get thickness(): number;
- set thickness(value: number);
- /**
- * Observable raised when isChecked property changes
- */
- onIsCheckedChangedObservable: Observable<boolean>;
- /** Gets or sets a value indicating the ratio between overall size and check size */
- get checkSizeRatio(): number;
- set checkSizeRatio(value: number);
- /** Gets or sets background color */
- get background(): string;
- set background(value: string);
- /** Gets or sets a boolean indicating if the checkbox is checked or not */
- get isChecked(): boolean;
- set isChecked(value: boolean);
- /**
- * Creates a new CheckBox
- * @param name defines the control name
- */
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- /** @hidden */
- _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: Nullable<Measure>): void;
- /** @hidden */
- _onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
- /**
- * Utility function to easily create a checkbox with a header
- * @param title defines the label to use for the header
- * @param onValueChanged defines the callback to call when value changes
- * @returns a StackPanel containing the checkbox and a textBlock
- */
- static AddCheckBoxWithHeader(title: string, onValueChanged: (value: boolean) => void): StackPanel;
- }
- }
- declare module "babylonjs-gui/2D/controls/virtualKeyboard" {
- import { Nullable } from "babylonjs/types";
- import { Observable } from "babylonjs/Misc/observable";
- import { StackPanel } from "babylonjs-gui/2D/controls/stackPanel";
- import { InputText } from "babylonjs-gui/2D/controls/inputText";
- /**
- * Class used to store key control properties
- */
- export class KeyPropertySet {
- /** Width */
- width?: string;
- /** Height */
- height?: string;
- /** Left padding */
- paddingLeft?: string;
- /** Right padding */
- paddingRight?: string;
- /** Top padding */
- paddingTop?: string;
- /** Bottom padding */
- paddingBottom?: string;
- /** Foreground color */
- color?: string;
- /** Background color */
- background?: string;
- }
- /**
- * Class used to create virtual keyboard
- */
- export class VirtualKeyboard extends StackPanel {
- /** Observable raised when a key is pressed */
- onKeyPressObservable: Observable<string>;
- /** Gets or sets default key button width */
- defaultButtonWidth: string;
- /** Gets or sets default key button height */
- defaultButtonHeight: string;
- /** Gets or sets default key button left padding */
- defaultButtonPaddingLeft: string;
- /** Gets or sets default key button right padding */
- defaultButtonPaddingRight: string;
- /** Gets or sets default key button top padding */
- defaultButtonPaddingTop: string;
- /** Gets or sets default key button bottom padding */
- defaultButtonPaddingBottom: string;
- /** Gets or sets default key button foreground color */
- defaultButtonColor: string;
- /** Gets or sets default key button background color */
- defaultButtonBackground: string;
- /** Gets or sets shift button foreground color */
- shiftButtonColor: string;
- /** Gets or sets shift button thickness*/
- selectedShiftThickness: number;
- /** Gets shift key state */
- shiftState: number;
- protected _getTypeName(): string;
- private _createKey;
- /**
- * Adds a new row of keys
- * @param keys defines the list of keys to add
- * @param propertySets defines the associated property sets
- */
- addKeysRow(keys: Array<string>, propertySets?: Array<KeyPropertySet>): void;
- /**
- * Set the shift key to a specific state
- * @param shiftState defines the new shift state
- */
- applyShiftState(shiftState: number): void;
- private _currentlyConnectedInputText;
- private _connectedInputTexts;
- private _onKeyPressObserver;
- /** Gets the input text control currently attached to the keyboard */
- get connectedInputText(): Nullable<InputText>;
- /**
- * Connects the keyboard with an input text control
- *
- * @param input defines the target control
- */
- connect(input: InputText): void;
- /**
- * Disconnects the keyboard from connected InputText controls
- *
- * @param input optionally defines a target control, otherwise all are disconnected
- */
- disconnect(input?: InputText): void;
- private _removeConnectedInputObservables;
- /**
- * Release all resources
- */
- dispose(): void;
- /**
- * Creates a new keyboard using a default layout
- *
- * @param name defines control name
- * @returns a new VirtualKeyboard
- */
- static CreateDefaultLayout(name?: string): VirtualKeyboard;
- }
- }
- declare module "babylonjs-gui/2D/controls/inputText" {
- import { Nullable } from "babylonjs/types";
- import { Observable } from "babylonjs/Misc/observable";
- import { Vector2 } from "babylonjs/Maths/math.vector";
- import { Control } from "babylonjs-gui/2D/controls/control";
- import { IFocusableControl } from "babylonjs-gui/2D/advancedDynamicTexture";
- import { VirtualKeyboard } from "babylonjs-gui/2D/controls/virtualKeyboard";
- import { Measure } from "babylonjs-gui/2D/measure";
- /**
- * Class used to create input text control
- */
- export class InputText extends Control implements IFocusableControl {
- name?: string | undefined;
- private _text;
- private _placeholderText;
- private _background;
- private _focusedBackground;
- private _focusedColor;
- private _placeholderColor;
- private _thickness;
- private _margin;
- private _autoStretchWidth;
- private _maxWidth;
- private _isFocused;
- private _blinkTimeout;
- private _blinkIsEven;
- private _cursorOffset;
- private _scrollLeft;
- private _textWidth;
- private _clickedCoordinate;
- private _deadKey;
- private _addKey;
- private _currentKey;
- private _isTextHighlightOn;
- private _textHighlightColor;
- private _highligherOpacity;
- private _highlightedText;
- private _startHighlightIndex;
- private _endHighlightIndex;
- private _cursorIndex;
- private _onFocusSelectAll;
- private _isPointerDown;
- private _onClipboardObserver;
- private _onPointerDblTapObserver;
- /** @hidden */
- _connectedVirtualKeyboard: Nullable<VirtualKeyboard>;
- /** Gets or sets a string representing the message displayed on mobile when the control gets the focus */
- promptMessage: string;
- /** Force disable prompt on mobile device */
- disableMobilePrompt: boolean;
- /** Observable raised when the text changes */
- onTextChangedObservable: Observable<InputText>;
- /** Observable raised just before an entered character is to be added */
- onBeforeKeyAddObservable: Observable<InputText>;
- /** Observable raised when the control gets the focus */
- onFocusObservable: Observable<InputText>;
- /** Observable raised when the control loses the focus */
- onBlurObservable: Observable<InputText>;
- /**Observable raised when the text is highlighted */
- onTextHighlightObservable: Observable<InputText>;
- /**Observable raised when copy event is triggered */
- onTextCopyObservable: Observable<InputText>;
- /** Observable raised when cut event is triggered */
- onTextCutObservable: Observable<InputText>;
- /** Observable raised when paste event is triggered */
- onTextPasteObservable: Observable<InputText>;
- /** Observable raised when a key event was processed */
- onKeyboardEventProcessedObservable: Observable<KeyboardEvent>;
- /** Gets or sets the maximum width allowed by the control */
- get maxWidth(): string | number;
- /** Gets the maximum width allowed by the control in pixels */
- get maxWidthInPixels(): number;
- set maxWidth(value: string | number);
- /** Gets or sets the text highlighter transparency; default: 0.4 */
- get highligherOpacity(): number;
- set highligherOpacity(value: number);
- /** Gets or sets a boolean indicating whether to select complete text by default on input focus */
- get onFocusSelectAll(): boolean;
- set onFocusSelectAll(value: boolean);
- /** Gets or sets the text hightlight color */
- get textHighlightColor(): string;
- set textHighlightColor(value: string);
- /** Gets or sets control margin */
- get margin(): string;
- /** Gets control margin in pixels */
- get marginInPixels(): number;
- set margin(value: string);
- /** Gets or sets a boolean indicating if the control can auto stretch its width to adapt to the text */
- get autoStretchWidth(): boolean;
- set autoStretchWidth(value: boolean);
- /** Gets or sets border thickness */
- get thickness(): number;
- set thickness(value: number);
- /** Gets or sets the background color when focused */
- get focusedBackground(): string;
- set focusedBackground(value: string);
- /** Gets or sets the background color when focused */
- get focusedColor(): string;
- set focusedColor(value: string);
- /** Gets or sets the background color */
- get background(): string;
- set background(value: string);
- /** Gets or sets the placeholder color */
- get placeholderColor(): string;
- set placeholderColor(value: string);
- /** Gets or sets the text displayed when the control is empty */
- get placeholderText(): string;
- set placeholderText(value: string);
- /** Gets or sets the dead key flag */
- get deadKey(): boolean;
- set deadKey(flag: boolean);
- /** Gets or sets the highlight text */
- get highlightedText(): string;
- set highlightedText(text: string);
- /** Gets or sets if the current key should be added */
- get addKey(): boolean;
- set addKey(flag: boolean);
- /** Gets or sets the value of the current key being entered */
- get currentKey(): string;
- set currentKey(key: string);
- /** Gets or sets the text displayed in the control */
- get text(): string;
- set text(value: string);
- /** Gets or sets control width */
- get width(): string | number;
- set width(value: string | number);
- /**
- * Creates a new InputText
- * @param name defines the control name
- * @param text defines the text of the control
- */
- constructor(name?: string | undefined, text?: string);
- /** @hidden */
- onBlur(): void;
- /** @hidden */
- onFocus(): void;
- protected _getTypeName(): string;
- /**
- * Function called to get the list of controls that should not steal the focus from this control
- * @returns an array of controls
- */
- keepsFocusWith(): Nullable<Control[]>;
- /** @hidden */
- processKey(keyCode: number, key?: string, evt?: KeyboardEvent): void;
- /** @hidden */
- private _updateValueFromCursorIndex;
- /** @hidden */
- private _processDblClick;
- /** @hidden */
- private _selectAllText;
- /**
- * Handles the keyboard event
- * @param evt Defines the KeyboardEvent
- */
- processKeyboard(evt: KeyboardEvent): void;
- /** @hidden */
- private _onCopyText;
- /** @hidden */
- private _onCutText;
- /** @hidden */
- private _onPasteText;
- _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: Nullable<Measure>): void;
- _onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
- _onPointerMove(target: Control, coordinates: Vector2, pointerId: number): void;
- _onPointerUp(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean): void;
- protected _beforeRenderText(text: string): string;
- dispose(): void;
- }
- }
- declare module "babylonjs-gui/2D/controls/grid" {
- import { Nullable } from "babylonjs/types";
- import { Container } from "babylonjs-gui/2D/controls/container";
- import { ValueAndUnit } from "babylonjs-gui/2D/valueAndUnit";
- import { Control } from "babylonjs-gui/2D/controls/control";
- import { Measure } from "babylonjs-gui/2D/measure";
- /**
- * Class used to create a 2D grid container
- */
- export class Grid extends Container {
- name?: string | undefined;
- private _rowDefinitions;
- private _columnDefinitions;
- private _cells;
- private _childControls;
- /**
- * Gets the number of columns
- */
- get columnCount(): number;
- /**
- * Gets the number of rows
- */
- get rowCount(): number;
- /** Gets the list of children */
- get children(): Control[];
- /** Gets the list of cells (e.g. the containers) */
- get cells(): {
- [key: string]: Container;
- };
- /**
- * Gets the definition of a specific row
- * @param index defines the index of the row
- * @returns the row definition
- */
- getRowDefinition(index: number): Nullable<ValueAndUnit>;
- /**
- * Gets the definition of a specific column
- * @param index defines the index of the column
- * @returns the column definition
- */
- getColumnDefinition(index: number): Nullable<ValueAndUnit>;
- /**
- * Adds a new row to the grid
- * @param height defines the height of the row (either in pixel or a value between 0 and 1)
- * @param isPixel defines if the height is expressed in pixel (or in percentage)
- * @returns the current grid
- */
- addRowDefinition(height: number, isPixel?: boolean): Grid;
- /**
- * Adds a new column to the grid
- * @param width defines the width of the column (either in pixel or a value between 0 and 1)
- * @param isPixel defines if the width is expressed in pixel (or in percentage)
- * @returns the current grid
- */
- addColumnDefinition(width: number, isPixel?: boolean): Grid;
- /**
- * Update a row definition
- * @param index defines the index of the row to update
- * @param height defines the height of the row (either in pixel or a value between 0 and 1)
- * @param isPixel defines if the weight is expressed in pixel (or in percentage)
- * @returns the current grid
- */
- setRowDefinition(index: number, height: number, isPixel?: boolean): Grid;
- /**
- * Update a column definition
- * @param index defines the index of the column to update
- * @param width defines the width of the column (either in pixel or a value between 0 and 1)
- * @param isPixel defines if the width is expressed in pixel (or in percentage)
- * @returns the current grid
- */
- setColumnDefinition(index: number, width: number, isPixel?: boolean): Grid;
- /**
- * Gets the list of children stored in a specific cell
- * @param row defines the row to check
- * @param column defines the column to check
- * @returns the list of controls
- */
- getChildrenAt(row: number, column: number): Nullable<Array<Control>>;
- /**
- * Gets a string representing the child cell info (row x column)
- * @param child defines the control to get info from
- * @returns a string containing the child cell info (row x column)
- */
- getChildCellInfo(child: Control): string;
- private _removeCell;
- private _offsetCell;
- /**
- * Remove a column definition at specified index
- * @param index defines the index of the column to remove
- * @returns the current grid
- */
- removeColumnDefinition(index: number): Grid;
- /**
- * Remove a row definition at specified index
- * @param index defines the index of the row to remove
- * @returns the current grid
- */
- removeRowDefinition(index: number): Grid;
- /**
- * Adds a new control to the current grid
- * @param control defines the control to add
- * @param row defines the row where to add the control (0 by default)
- * @param column defines the column where to add the control (0 by default)
- * @returns the current grid
- */
- addControl(control: Control, row?: number, column?: number): Grid;
- /**
- * Removes a control from the current container
- * @param control defines the control to remove
- * @returns the current container
- */
- removeControl(control: Control): Container;
- /**
- * Creates a new Grid
- * @param name defines control name
- */
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- protected _getGridDefinitions(definitionCallback: (lefts: number[], tops: number[], widths: number[], heights: number[]) => void): void;
- protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- _flagDescendantsAsMatrixDirty(): void;
- _renderHighlightSpecific(context: CanvasRenderingContext2D): void;
- /** Releases associated resources */
- dispose(): void;
- }
- }
- declare module "babylonjs-gui/2D/controls/colorpicker" {
- import { Observable } from "babylonjs/Misc/observable";
- import { Vector2 } from "babylonjs/Maths/math.vector";
- import { Control } from "babylonjs-gui/2D/controls/control";
- import { Measure } from "babylonjs-gui/2D/measure";
- import { AdvancedDynamicTexture } from "babylonjs-gui/2D/advancedDynamicTexture";
- import { Color3 } from 'babylonjs/Maths/math.color';
- /** Class used to create color pickers */
- export class ColorPicker extends Control {
- name?: string | undefined;
- private static _Epsilon;
- private _colorWheelCanvas;
- private _value;
- private _tmpColor;
- private _pointerStartedOnSquare;
- private _pointerStartedOnWheel;
- private _squareLeft;
- private _squareTop;
- private _squareSize;
- private _h;
- private _s;
- private _v;
- private _lastPointerDownID;
- /**
- * Observable raised when the value changes
- */
- onValueChangedObservable: Observable<Color3>;
- /** Gets or sets the color of the color picker */
- get value(): Color3;
- set value(value: Color3);
- /**
- * Gets or sets control width
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get width(): string | number;
- set width(value: string | number);
- /**
- * Gets or sets control height
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get height(): string | number;
- /** Gets or sets control height */
- set height(value: string | number);
- /** Gets or sets control size */
- get size(): string | number;
- set size(value: string | number);
- /**
- * Creates a new ColorPicker
- * @param name defines the control name
- */
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- /** @hidden */
- protected _preMeasure(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- private _updateSquareProps;
- private _drawGradientSquare;
- private _drawCircle;
- private _createColorWheelCanvas;
- /** @hidden */
- _draw(context: CanvasRenderingContext2D): void;
- private _pointerIsDown;
- private _updateValueFromPointer;
- private _isPointOnSquare;
- private _isPointOnWheel;
- _onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
- _onPointerMove(target: Control, coordinates: Vector2, pointerId: number): void;
- _onPointerUp(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean): void;
- _onCanvasBlur(): void;
- /**
- * This function expands the color picker by creating a color picker dialog with manual
- * color value input and the ability to save colors into an array to be used later in
- * subsequent launches of the dialogue.
- * @param advancedTexture defines the AdvancedDynamicTexture the dialog is assigned to
- * @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.
- * @returns picked color as a hex string and the saved colors array as hex strings.
- */
- static ShowPickerDialogAsync(advancedTexture: AdvancedDynamicTexture, options: {
- pickerWidth?: string;
- pickerHeight?: string;
- headerHeight?: string;
- lastColor?: string;
- swatchLimit?: number;
- numSwatchesPerLine?: number;
- savedColors?: Array<string>;
- }): Promise<{
- savedColors?: string[];
- pickedColor: string;
- }>;
- }
- }
- declare module "babylonjs-gui/2D/controls/ellipse" {
- import { Container } from "babylonjs-gui/2D/controls/container";
- import { Measure } from "babylonjs-gui/2D/measure";
- /** Class used to create 2D ellipse containers */
- export class Ellipse extends Container {
- name?: string | undefined;
- private _thickness;
- /** Gets or sets border thickness */
- get thickness(): number;
- set thickness(value: number);
- /**
- * Creates a new Ellipse
- * @param name defines the control name
- */
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- protected _localDraw(context: CanvasRenderingContext2D): void;
- protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- protected _clipForChildren(context: CanvasRenderingContext2D): void;
- }
- }
- declare module "babylonjs-gui/2D/controls/inputPassword" {
- import { InputText } from "babylonjs-gui/2D/controls/inputText";
- /**
- * Class used to create a password control
- */
- export class InputPassword extends InputText {
- protected _beforeRenderText(text: string): string;
- }
- }
- declare module "babylonjs-gui/2D/controls/line" {
- import { Vector3 } from "babylonjs/Maths/math.vector";
- import { Scene } from "babylonjs/scene";
- import { Control } from "babylonjs-gui/2D/controls/control";
- import { Measure } from "babylonjs-gui/2D/measure";
- /** Class used to render 2D lines */
- export class Line extends Control {
- name?: string | undefined;
- private _lineWidth;
- private _x1;
- private _y1;
- private _x2;
- private _y2;
- private _dash;
- private _connectedControl;
- private _connectedControlDirtyObserver;
- /** Gets or sets the dash pattern */
- get dash(): Array<number>;
- set dash(value: Array<number>);
- /** Gets or sets the control connected with the line end */
- get connectedControl(): Control;
- set connectedControl(value: Control);
- /** Gets or sets start coordinates on X axis */
- get x1(): string | number;
- set x1(value: string | number);
- /** Gets or sets start coordinates on Y axis */
- get y1(): string | number;
- set y1(value: string | number);
- /** Gets or sets end coordinates on X axis */
- get x2(): string | number;
- set x2(value: string | number);
- /** Gets or sets end coordinates on Y axis */
- get y2(): string | number;
- set y2(value: string | number);
- /** Gets or sets line width */
- get lineWidth(): number;
- set lineWidth(value: number);
- /** Gets or sets horizontal alignment */
- set horizontalAlignment(value: number);
- /** Gets or sets vertical alignment */
- set verticalAlignment(value: number);
- private get _effectiveX2();
- private get _effectiveY2();
- /**
- * Creates a new Line
- * @param name defines the control name
- */
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- _draw(context: CanvasRenderingContext2D): void;
- _measure(): void;
- protected _computeAlignment(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- /**
- * Move one end of the line given 3D cartesian coordinates.
- * @param position Targeted world position
- * @param scene Scene
- * @param end (opt) Set to true to assign x2 and y2 coordinates of the line. Default assign to x1 and y1.
- */
- moveToVector3(position: Vector3, scene: Scene, end?: boolean): void;
- /**
- * Move one end of the line to a position in screen absolute space.
- * @param projectedPosition Position in screen absolute space (X, Y)
- * @param end (opt) Set to true to assign x2 and y2 coordinates of the line. Default assign to x1 and y1.
- */
- _moveToProjectedPosition(projectedPosition: Vector3, end?: boolean): void;
- }
- }
- declare module "babylonjs-gui/2D/multiLinePoint" {
- import { Nullable } from "babylonjs/types";
- import { Vector2 } from "babylonjs/Maths/math.vector";
- import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
- import { MultiLine } from "babylonjs-gui/2D/controls/multiLine";
- import { Control } from "babylonjs-gui/2D/controls/control";
- /**
- * Class used to store a point for a MultiLine object.
- * The point can be pure 2D coordinates, a mesh or a control
- */
- export class MultiLinePoint {
- private _multiLine;
- private _x;
- private _y;
- private _control;
- private _mesh;
- private _controlObserver;
- private _meshObserver;
- /** @hidden */
- _point: Vector2;
- /**
- * Creates a new MultiLinePoint
- * @param multiLine defines the source MultiLine object
- */
- constructor(multiLine: MultiLine);
- /** Gets or sets x coordinate */
- get x(): string | number;
- set x(value: string | number);
- /** Gets or sets y coordinate */
- get y(): string | number;
- set y(value: string | number);
- /** Gets or sets the control associated with this point */
- get control(): Nullable<Control>;
- set control(value: Nullable<Control>);
- /** Gets or sets the mesh associated with this point */
- get mesh(): Nullable<AbstractMesh>;
- set mesh(value: Nullable<AbstractMesh>);
- /** Resets links */
- resetLinks(): void;
- /**
- * Gets a translation vector
- * @returns the translation vector
- */
- translate(): Vector2;
- private _translatePoint;
- /** Release associated resources */
- dispose(): void;
- }
- }
- declare module "babylonjs-gui/2D/controls/multiLine" {
- import { Nullable } from "babylonjs/types";
- import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
- import { Control } from "babylonjs-gui/2D/controls/control";
- import { MultiLinePoint } from "babylonjs-gui/2D/multiLinePoint";
- import { Measure } from "babylonjs-gui/2D/measure";
- /**
- * Class used to create multi line control
- */
- export class MultiLine extends Control {
- name?: string | undefined;
- private _lineWidth;
- private _dash;
- private _points;
- private _minX;
- private _minY;
- private _maxX;
- private _maxY;
- /**
- * Creates a new MultiLine
- * @param name defines the control name
- */
- constructor(name?: string | undefined);
- /** Gets or sets dash pattern */
- get dash(): Array<number>;
- set dash(value: Array<number>);
- /**
- * Gets point stored at specified index
- * @param index defines the index to look for
- * @returns the requested point if found
- */
- getAt(index: number): MultiLinePoint;
- /** Function called when a point is updated */
- onPointUpdate: () => void;
- /**
- * Adds new points to the point collection
- * @param items defines the list of items (mesh, control or 2d coordiantes) to add
- * @returns the list of created MultiLinePoint
- */
- add(...items: (AbstractMesh | Control | {
- x: string | number;
- y: string | number;
- })[]): MultiLinePoint[];
- /**
- * Adds a new point to the point collection
- * @param item defines the item (mesh, control or 2d coordiantes) to add
- * @returns the created MultiLinePoint
- */
- push(item?: (AbstractMesh | Control | {
- x: string | number;
- y: string | number;
- })): MultiLinePoint;
- /**
- * Remove a specific value or point from the active point collection
- * @param value defines the value or point to remove
- */
- remove(value: number | MultiLinePoint): void;
- /**
- * Resets this object to initial state (no point)
- */
- reset(): void;
- /**
- * Resets all links
- */
- resetLinks(): void;
- /** Gets or sets line width */
- get lineWidth(): number;
- set lineWidth(value: number);
- set horizontalAlignment(value: number);
- set verticalAlignment(value: number);
- protected _getTypeName(): string;
- _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: Nullable<Measure>): void;
- protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- _measure(): void;
- protected _computeAlignment(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- dispose(): void;
- }
- }
- declare module "babylonjs-gui/2D/controls/radioButton" {
- import { Observable } from "babylonjs/Misc/observable";
- import { Vector2 } from "babylonjs/Maths/math.vector";
- import { Control } from "babylonjs-gui/2D/controls/control";
- import { StackPanel } from "babylonjs-gui/2D/controls/stackPanel";
- /**
- * Class used to create radio button controls
- */
- export class RadioButton extends Control {
- name?: string | undefined;
- private _isChecked;
- private _background;
- private _checkSizeRatio;
- private _thickness;
- /** Gets or sets border thickness */
- get thickness(): number;
- set thickness(value: number);
- /** Gets or sets group name */
- group: string;
- /** Observable raised when isChecked is changed */
- onIsCheckedChangedObservable: Observable<boolean>;
- /** Gets or sets a value indicating the ratio between overall size and check size */
- get checkSizeRatio(): number;
- set checkSizeRatio(value: number);
- /** Gets or sets background color */
- get background(): string;
- set background(value: string);
- /** Gets or sets a boolean indicating if the checkbox is checked or not */
- get isChecked(): boolean;
- set isChecked(value: boolean);
- /**
- * Creates a new RadioButton
- * @param name defines the control name
- */
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- _draw(context: CanvasRenderingContext2D): void;
- _onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
- /**
- * Utility function to easily create a radio button with a header
- * @param title defines the label to use for the header
- * @param group defines the group to use for the radio button
- * @param isChecked defines the initial state of the radio button
- * @param onValueChanged defines the callback to call when value changes
- * @returns a StackPanel containing the radio button and a textBlock
- */
- static AddRadioButtonWithHeader(title: string, group: string, isChecked: boolean, onValueChanged: (button: RadioButton, value: boolean) => void): StackPanel;
- }
- }
- declare module "babylonjs-gui/2D/controls/sliders/baseSlider" {
- import { Observable } from "babylonjs/Misc/observable";
- import { Vector2 } from "babylonjs/Maths/math.vector";
- import { Control } from "babylonjs-gui/2D/controls/control";
- import { ValueAndUnit } from "babylonjs-gui/2D/valueAndUnit";
- /**
- * Class used to create slider controls
- */
- export class BaseSlider extends Control {
- name?: string | undefined;
- protected _thumbWidth: ValueAndUnit;
- private _minimum;
- private _maximum;
- private _value;
- private _isVertical;
- protected _barOffset: ValueAndUnit;
- private _isThumbClamped;
- protected _displayThumb: boolean;
- private _step;
- private _lastPointerDownID;
- protected _effectiveBarOffset: number;
- protected _renderLeft: number;
- protected _renderTop: number;
- protected _renderWidth: number;
- protected _renderHeight: number;
- protected _backgroundBoxLength: number;
- protected _backgroundBoxThickness: number;
- protected _effectiveThumbThickness: number;
- /** Observable raised when the sldier value changes */
- onValueChangedObservable: Observable<number>;
- /** Gets or sets a boolean indicating if the thumb must be rendered */
- get displayThumb(): boolean;
- set displayThumb(value: boolean);
- /** Gets or sets a step to apply to values (0 by default) */
- get step(): number;
- set step(value: number);
- /** Gets or sets main bar offset (ie. the margin applied to the value bar) */
- get barOffset(): string | number;
- /** Gets main bar offset in pixels*/
- get barOffsetInPixels(): number;
- set barOffset(value: string | number);
- /** Gets or sets thumb width */
- get thumbWidth(): string | number;
- /** Gets thumb width in pixels */
- get thumbWidthInPixels(): number;
- set thumbWidth(value: string | number);
- /** Gets or sets minimum value */
- get minimum(): number;
- set minimum(value: number);
- /** Gets or sets maximum value */
- get maximum(): number;
- set maximum(value: number);
- /** Gets or sets current value */
- get value(): number;
- set value(value: number);
- /**Gets or sets a boolean indicating if the slider should be vertical or horizontal */
- get isVertical(): boolean;
- set isVertical(value: boolean);
- /** Gets or sets a value indicating if the thumb can go over main bar extends */
- get isThumbClamped(): boolean;
- set isThumbClamped(value: boolean);
- /**
- * Creates a new BaseSlider
- * @param name defines the control name
- */
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- protected _getThumbPosition(): number;
- protected _getThumbThickness(type: string): number;
- protected _prepareRenderingData(type: string): void;
- private _pointerIsDown;
- /** @hidden */
- protected _updateValueFromPointer(x: number, y: number): void;
- _onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
- _onPointerMove(target: Control, coordinates: Vector2, pointerId: number): void;
- _onPointerUp(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean): void;
- _onCanvasBlur(): void;
- }
- }
- declare module "babylonjs-gui/2D/controls/sliders/slider" {
- import { BaseSlider } from "babylonjs-gui/2D/controls/sliders/baseSlider";
- import { Nullable } from 'babylonjs/types';
- import { Measure } from "babylonjs-gui/2D/measure";
- /**
- * Class used to create slider controls
- */
- export class Slider extends BaseSlider {
- name?: string | undefined;
- private _background;
- private _borderColor;
- private _thumbColor;
- private _isThumbCircle;
- protected _displayValueBar: boolean;
- /** Gets or sets a boolean indicating if the value bar must be rendered */
- get displayValueBar(): boolean;
- set displayValueBar(value: boolean);
- /** Gets or sets border color */
- get borderColor(): string;
- set borderColor(value: string);
- /** Gets or sets background color */
- get background(): string;
- set background(value: string);
- /** Gets or sets thumb's color */
- get thumbColor(): string;
- set thumbColor(value: string);
- /** Gets or sets a boolean indicating if the thumb should be round or square */
- get isThumbCircle(): boolean;
- set isThumbCircle(value: boolean);
- /**
- * Creates a new Slider
- * @param name defines the control name
- */
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: Nullable<Measure>): void;
- }
- }
- declare module "babylonjs-gui/2D/controls/selector" {
- import { Rectangle } from "babylonjs-gui/2D/controls/rectangle";
- import { StackPanel } from "babylonjs-gui/2D/controls/stackPanel";
- /** Class used to create a RadioGroup
- * which contains groups of radio buttons
- */
- export class SelectorGroup {
- /** name of SelectorGroup */
- name: string;
- private _groupPanel;
- private _selectors;
- private _groupHeader;
- /**
- * Creates a new SelectorGroup
- * @param name of group, used as a group heading
- */
- constructor(
- /** name of SelectorGroup */
- name: string);
- /** Gets the groupPanel of the SelectorGroup */
- get groupPanel(): StackPanel;
- /** Gets the selectors array */
- get selectors(): StackPanel[];
- /** Gets and sets the group header */
- get header(): string;
- set header(label: string);
- /** @hidden */
- private _addGroupHeader;
- /** @hidden*/
- _getSelector(selectorNb: number): StackPanel | undefined;
- /** Removes the selector at the given position
- * @param selectorNb the position of the selector within the group
- */
- removeSelector(selectorNb: number): void;
- }
- /** Class used to create a CheckboxGroup
- * which contains groups of checkbox buttons
- */
- export class CheckboxGroup extends SelectorGroup {
- /** Adds a checkbox as a control
- * @param text is the label for the selector
- * @param func is the function called when the Selector is checked
- * @param checked is true when Selector is checked
- */
- addCheckbox(text: string, func?: (s: boolean) => void, checked?: boolean): void;
- /** @hidden */
- _setSelectorLabel(selectorNb: number, label: string): void;
- /** @hidden */
- _setSelectorLabelColor(selectorNb: number, color: string): void;
- /** @hidden */
- _setSelectorButtonColor(selectorNb: number, color: string): void;
- /** @hidden */
- _setSelectorButtonBackground(selectorNb: number, color: string): void;
- }
- /** Class used to create a RadioGroup
- * which contains groups of radio buttons
- */
- export class RadioGroup extends SelectorGroup {
- private _selectNb;
- /** Adds a radio button as a control
- * @param label is the label for the selector
- * @param func is the function called when the Selector is checked
- * @param checked is true when Selector is checked
- */
- addRadio(label: string, func?: (n: number) => void, checked?: boolean): void;
- /** @hidden */
- _setSelectorLabel(selectorNb: number, label: string): void;
- /** @hidden */
- _setSelectorLabelColor(selectorNb: number, color: string): void;
- /** @hidden */
- _setSelectorButtonColor(selectorNb: number, color: string): void;
- /** @hidden */
- _setSelectorButtonBackground(selectorNb: number, color: string): void;
- }
- /** Class used to create a SliderGroup
- * which contains groups of slider buttons
- */
- export class SliderGroup extends SelectorGroup {
- /**
- * Adds a slider to the SelectorGroup
- * @param label is the label for the SliderBar
- * @param func is the function called when the Slider moves
- * @param unit is a string describing the units used, eg degrees or metres
- * @param min is the minimum value for the Slider
- * @param max is the maximum value for the Slider
- * @param value is the start value for the Slider between min and max
- * @param onValueChange is the function used to format the value displayed, eg radians to degrees
- */
- addSlider(label: string, func?: (v: number) => void, unit?: string, min?: number, max?: number, value?: number, onValueChange?: (v: number) => number): void;
- /** @hidden */
- _setSelectorLabel(selectorNb: number, label: string): void;
- /** @hidden */
- _setSelectorLabelColor(selectorNb: number, color: string): void;
- /** @hidden */
- _setSelectorButtonColor(selectorNb: number, color: string): void;
- /** @hidden */
- _setSelectorButtonBackground(selectorNb: number, color: string): void;
- }
- /** Class used to hold the controls for the checkboxes, radio buttons and sliders
- * @see https://doc.babylonjs.com/how_to/selector
- */
- export class SelectionPanel extends Rectangle {
- /** name of SelectionPanel */
- name: string;
- /** an array of SelectionGroups */
- groups: SelectorGroup[];
- private _panel;
- private _buttonColor;
- private _buttonBackground;
- private _headerColor;
- private _barColor;
- private _barHeight;
- private _spacerHeight;
- private _labelColor;
- private _groups;
- private _bars;
- /**
- * Creates a new SelectionPanel
- * @param name of SelectionPanel
- * @param groups is an array of SelectionGroups
- */
- constructor(
- /** name of SelectionPanel */
- name: string,
- /** an array of SelectionGroups */
- groups?: SelectorGroup[]);
- protected _getTypeName(): string;
- /** Gets or sets the headerColor */
- get headerColor(): string;
- set headerColor(color: string);
- private _setHeaderColor;
- /** Gets or sets the button color */
- get buttonColor(): string;
- set buttonColor(color: string);
- private _setbuttonColor;
- /** Gets or sets the label color */
- get labelColor(): string;
- set labelColor(color: string);
- private _setLabelColor;
- /** Gets or sets the button background */
- get buttonBackground(): string;
- set buttonBackground(color: string);
- private _setButtonBackground;
- /** Gets or sets the color of separator bar */
- get barColor(): string;
- set barColor(color: string);
- private _setBarColor;
- /** Gets or sets the height of separator bar */
- get barHeight(): string;
- set barHeight(value: string);
- private _setBarHeight;
- /** Gets or sets the height of spacers*/
- get spacerHeight(): string;
- set spacerHeight(value: string);
- private _setSpacerHeight;
- /** Adds a bar between groups */
- private _addSpacer;
- /** Add a group to the selection panel
- * @param group is the selector group to add
- */
- addGroup(group: SelectorGroup): void;
- /** Remove the group from the given position
- * @param groupNb is the position of the group in the list
- */
- removeGroup(groupNb: number): void;
- /** Change a group header label
- * @param label is the new group header label
- * @param groupNb is the number of the group to relabel
- * */
- setHeaderName(label: string, groupNb: number): void;
- /** Change selector label to the one given
- * @param label is the new selector label
- * @param groupNb is the number of the groupcontaining the selector
- * @param selectorNb is the number of the selector within a group to relabel
- * */
- relabel(label: string, groupNb: number, selectorNb: number): void;
- /** For a given group position remove the selector at the given position
- * @param groupNb is the number of the group to remove the selector from
- * @param selectorNb is the number of the selector within the group
- */
- removeFromGroupSelector(groupNb: number, selectorNb: number): void;
- /** For a given group position of correct type add a checkbox button
- * @param groupNb is the number of the group to remove the selector from
- * @param label is the label for the selector
- * @param func is the function called when the Selector is checked
- * @param checked is true when Selector is checked
- */
- addToGroupCheckbox(groupNb: number, label: string, func?: () => void, checked?: boolean): void;
- /** For a given group position of correct type add a radio button
- * @param groupNb is the number of the group to remove the selector from
- * @param label is the label for the selector
- * @param func is the function called when the Selector is checked
- * @param checked is true when Selector is checked
- */
- addToGroupRadio(groupNb: number, label: string, func?: () => void, checked?: boolean): void;
- /**
- * For a given slider group add a slider
- * @param groupNb is the number of the group to add the slider to
- * @param label is the label for the Slider
- * @param func is the function called when the Slider moves
- * @param unit is a string describing the units used, eg degrees or metres
- * @param min is the minimum value for the Slider
- * @param max is the maximum value for the Slider
- * @param value is the start value for the Slider between min and max
- * @param onVal is the function used to format the value displayed, eg radians to degrees
- */
- addToGroupSlider(groupNb: number, label: string, func?: () => void, unit?: string, min?: number, max?: number, value?: number, onVal?: (v: number) => number): void;
- }
- }
- declare module "babylonjs-gui/2D/controls/scrollViewers/scrollViewerWindow" {
- import { Measure } from "babylonjs-gui/2D/measure";
- import { Container } from "babylonjs-gui/2D/controls/container";
- /**
- * Class used to hold a the container for ScrollViewer
- * @hidden
- */
- export class _ScrollViewerWindow extends Container {
- parentClientWidth: number;
- parentClientHeight: number;
- private _freezeControls;
- private _parentMeasure;
- private _oldLeft;
- private _oldTop;
- get freezeControls(): boolean;
- set freezeControls(value: boolean);
- private _bucketWidth;
- private _bucketHeight;
- private _buckets;
- private _bucketLen;
- get bucketWidth(): number;
- get bucketHeight(): number;
- setBucketSizes(width: number, height: number): void;
- private _useBuckets;
- private _makeBuckets;
- private _dispatchInBuckets;
- private _updateMeasures;
- private _updateChildrenMeasures;
- private _restoreMeasures;
- /**
- * Creates a new ScrollViewerWindow
- * @param name of ScrollViewerWindow
- */
- constructor(name?: string);
- protected _getTypeName(): string;
- /** @hidden */
- protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- /** @hidden */
- _layout(parentMeasure: Measure, context: CanvasRenderingContext2D): boolean;
- private _scrollChildren;
- private _scrollChildrenWithBuckets;
- /** @hidden */
- _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: Measure): void;
- protected _postMeasure(): void;
- }
- }
- declare module "babylonjs-gui/2D/controls/sliders/scrollBar" {
- import { Vector2 } from "babylonjs/Maths/math.vector";
- import { BaseSlider } from "babylonjs-gui/2D/controls/sliders/baseSlider";
- import { Control } from "babylonjs-gui/2D/controls/control";
- /**
- * Class used to create slider controls
- */
- export class ScrollBar extends BaseSlider {
- name?: string | undefined;
- private _background;
- private _borderColor;
- private _tempMeasure;
- /** Gets or sets border color */
- get borderColor(): string;
- set borderColor(value: string);
- /** Gets or sets background color */
- get background(): string;
- set background(value: string);
- /**
- * Creates a new Slider
- * @param name defines the control name
- */
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- protected _getThumbThickness(): number;
- _draw(context: CanvasRenderingContext2D): void;
- private _first;
- private _originX;
- private _originY;
- /** @hidden */
- protected _updateValueFromPointer(x: number, y: number): void;
- _onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
- }
- }
- declare module "babylonjs-gui/2D/controls/sliders/imageScrollBar" {
- import { Vector2 } from "babylonjs/Maths/math.vector";
- import { BaseSlider } from "babylonjs-gui/2D/controls/sliders/baseSlider";
- import { Control } from "babylonjs-gui/2D/controls/control";
- import { Image } from "babylonjs-gui/2D/controls/image";
- /**
- * Class used to create slider controls
- */
- export class ImageScrollBar extends BaseSlider {
- name?: string | undefined;
- private _backgroundBaseImage;
- private _backgroundImage;
- private _thumbImage;
- private _thumbBaseImage;
- private _thumbLength;
- private _thumbHeight;
- private _barImageHeight;
- private _tempMeasure;
- /** Number of 90° rotation to apply on the images when in vertical mode */
- num90RotationInVerticalMode: number;
- /**
- * Gets or sets the image used to render the background for horizontal bar
- */
- get backgroundImage(): Image;
- set backgroundImage(value: Image);
- /**
- * Gets or sets the image used to render the thumb
- */
- get thumbImage(): Image;
- set thumbImage(value: Image);
- /**
- * Gets or sets the length of the thumb
- */
- get thumbLength(): number;
- set thumbLength(value: number);
- /**
- * Gets or sets the height of the thumb
- */
- get thumbHeight(): number;
- set thumbHeight(value: number);
- /**
- * Gets or sets the height of the bar image
- */
- get barImageHeight(): number;
- set barImageHeight(value: number);
- /**
- * Creates a new ImageScrollBar
- * @param name defines the control name
- */
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- protected _getThumbThickness(): number;
- _draw(context: CanvasRenderingContext2D): void;
- private _first;
- private _originX;
- private _originY;
- /** @hidden */
- protected _updateValueFromPointer(x: number, y: number): void;
- _onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
- }
- }
- declare module "babylonjs-gui/2D/controls/scrollViewers/scrollViewer" {
- import { Nullable } from "babylonjs/types";
- import { Rectangle } from "babylonjs-gui/2D/controls/rectangle";
- import { Image } from "babylonjs-gui/2D/controls/image";
- import { Control } from "babylonjs-gui/2D/controls/control";
- import { Container } from "babylonjs-gui/2D/controls/container";
- import { Measure } from "babylonjs-gui/2D/measure";
- import { AdvancedDynamicTexture } from "babylonjs-gui/2D/advancedDynamicTexture";
- import { ScrollBar } from "babylonjs-gui/2D/controls/sliders/scrollBar";
- import { ImageScrollBar } from "babylonjs-gui/2D/controls/sliders/imageScrollBar";
- /**
- * Class used to hold a viewer window and sliders in a grid
- */
- export class ScrollViewer extends Rectangle {
- private _grid;
- private _horizontalBarSpace;
- private _verticalBarSpace;
- private _dragSpace;
- private _horizontalBar;
- private _verticalBar;
- private _barColor;
- private _barBackground;
- private _barImage;
- private _horizontalBarImage;
- private _verticalBarImage;
- private _barBackgroundImage;
- private _horizontalBarBackgroundImage;
- private _verticalBarBackgroundImage;
- private _barSize;
- private _window;
- private _pointerIsOver;
- private _wheelPrecision;
- private _onWheelObserver;
- private _clientWidth;
- private _clientHeight;
- private _useImageBar;
- private _thumbLength;
- private _thumbHeight;
- private _barImageHeight;
- private _horizontalBarImageHeight;
- private _verticalBarImageHeight;
- private _oldWindowContentsWidth;
- private _oldWindowContentsHeight;
- /**
- * Gets the horizontal scrollbar
- */
- get horizontalBar(): ScrollBar | ImageScrollBar;
- /**
- * Gets the vertical scrollbar
- */
- get verticalBar(): ScrollBar | ImageScrollBar;
- /**
- * Adds a new control to the current container
- * @param control defines the control to add
- * @returns the current container
- */
- addControl(control: Nullable<Control>): Container;
- /**
- * Removes a control from the current container
- * @param control defines the control to remove
- * @returns the current container
- */
- removeControl(control: Control): Container;
- /** Gets the list of children */
- get children(): Control[];
- _flagDescendantsAsMatrixDirty(): void;
- /**
- * Freezes or unfreezes the controls in the window.
- * When controls are frozen, the scroll viewer can render a lot more quickly but updates to positions/sizes of controls
- * are not taken into account. If you want to change positions/sizes, unfreeze, perform the changes then freeze again
- */
- get freezeControls(): boolean;
- set freezeControls(value: boolean);
- /** Gets the bucket width */
- get bucketWidth(): number;
- /** Gets the bucket height */
- get bucketHeight(): number;
- /**
- * Sets the bucket sizes.
- * When freezeControls is true, setting a non-zero bucket size will improve performances by updating only
- * controls that are visible. The bucket sizes is used to subdivide (internally) the window area to smaller areas into which
- * controls are dispatched. So, the size should be roughly equals to the mean size of all the controls of
- * the window. To disable the usage of buckets, sets either width or height (or both) to 0.
- * Please note that using this option will raise the memory usage (the higher the bucket sizes, the less memory
- * used), that's why it is not enabled by default.
- * @param width width of the bucket
- * @param height height of the bucket
- */
- setBucketSizes(width: number, height: number): void;
- private _forceHorizontalBar;
- private _forceVerticalBar;
- /**
- * Forces the horizontal scroll bar to be displayed
- */
- get forceHorizontalBar(): boolean;
- set forceHorizontalBar(value: boolean);
- /**
- * Forces the vertical scroll bar to be displayed
- */
- get forceVerticalBar(): boolean;
- set forceVerticalBar(value: boolean);
- /**
- * Creates a new ScrollViewer
- * @param name of ScrollViewer
- */
- constructor(name?: string, isImageBased?: boolean);
- /** Reset the scroll viewer window to initial size */
- resetWindow(): void;
- protected _getTypeName(): string;
- private _buildClientSizes;
- protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- protected _postMeasure(): void;
- /**
- * Gets or sets the mouse wheel precision
- * from 0 to 1 with a default value of 0.05
- * */
- get wheelPrecision(): number;
- set wheelPrecision(value: number);
- /** Gets or sets the scroll bar container background color */
- get scrollBackground(): string;
- set scrollBackground(color: string);
- /** Gets or sets the bar color */
- get barColor(): string;
- set barColor(color: string);
- /** Gets or sets the bar image */
- get thumbImage(): Image;
- set thumbImage(value: Image);
- /** Gets or sets the horizontal bar image */
- get horizontalThumbImage(): Image;
- set horizontalThumbImage(value: Image);
- /** Gets or sets the vertical bar image */
- get verticalThumbImage(): Image;
- set verticalThumbImage(value: Image);
- /** Gets or sets the size of the bar */
- get barSize(): number;
- set barSize(value: number);
- /** Gets or sets the length of the thumb */
- get thumbLength(): number;
- set thumbLength(value: number);
- /** Gets or sets the height of the thumb */
- get thumbHeight(): number;
- set thumbHeight(value: number);
- /** Gets or sets the height of the bar image */
- get barImageHeight(): number;
- set barImageHeight(value: number);
- /** Gets or sets the height of the horizontal bar image */
- get horizontalBarImageHeight(): number;
- set horizontalBarImageHeight(value: number);
- /** Gets or sets the height of the vertical bar image */
- get verticalBarImageHeight(): number;
- set verticalBarImageHeight(value: number);
- /** Gets or sets the bar background */
- get barBackground(): string;
- set barBackground(color: string);
- /** Gets or sets the bar background image */
- get barImage(): Image;
- set barImage(value: Image);
- /** Gets or sets the horizontal bar background image */
- get horizontalBarImage(): Image;
- set horizontalBarImage(value: Image);
- /** Gets or sets the vertical bar background image */
- get verticalBarImage(): Image;
- set verticalBarImage(value: Image);
- private _setWindowPosition;
- /** @hidden */
- private _updateScroller;
- _link(host: AdvancedDynamicTexture): void;
- /** @hidden */
- private _addBar;
- /** @hidden */
- private _attachWheel;
- _renderHighlightSpecific(context: CanvasRenderingContext2D): void;
- /** Releases associated resources */
- dispose(): void;
- }
- }
- declare module "babylonjs-gui/2D/controls/displayGrid" {
- import { Control } from "babylonjs-gui/2D/controls/control";
- import { Nullable } from 'babylonjs/types';
- import { Measure } from "babylonjs-gui/2D/measure";
- /** Class used to render a grid */
- export class DisplayGrid extends Control {
- name?: string | undefined;
- private _cellWidth;
- private _cellHeight;
- private _minorLineTickness;
- private _minorLineColor;
- private _majorLineTickness;
- private _majorLineColor;
- private _majorLineFrequency;
- private _background;
- private _displayMajorLines;
- private _displayMinorLines;
- /** Gets or sets a boolean indicating if minor lines must be rendered (true by default)) */
- get displayMinorLines(): boolean;
- set displayMinorLines(value: boolean);
- /** Gets or sets a boolean indicating if major lines must be rendered (true by default)) */
- get displayMajorLines(): boolean;
- set displayMajorLines(value: boolean);
- /** Gets or sets background color (Black by default) */
- get background(): string;
- set background(value: string);
- /** Gets or sets the width of each cell (20 by default) */
- get cellWidth(): number;
- set cellWidth(value: number);
- /** Gets or sets the height of each cell (20 by default) */
- get cellHeight(): number;
- set cellHeight(value: number);
- /** Gets or sets the tickness of minor lines (1 by default) */
- get minorLineTickness(): number;
- set minorLineTickness(value: number);
- /** Gets or sets the color of minor lines (DarkGray by default) */
- get minorLineColor(): string;
- set minorLineColor(value: string);
- /** Gets or sets the tickness of major lines (2 by default) */
- get majorLineTickness(): number;
- set majorLineTickness(value: number);
- /** Gets or sets the color of major lines (White by default) */
- get majorLineColor(): string;
- set majorLineColor(value: string);
- /** Gets or sets the frequency of major lines (default is 1 every 5 minor lines)*/
- get majorLineFrequency(): number;
- set majorLineFrequency(value: number);
- /**
- * Creates a new GridDisplayRectangle
- * @param name defines the control name
- */
- constructor(name?: string | undefined);
- _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: Nullable<Measure>): void;
- protected _getTypeName(): string;
- }
- }
- declare module "babylonjs-gui/2D/controls/sliders/imageBasedSlider" {
- import { BaseSlider } from "babylonjs-gui/2D/controls/sliders/baseSlider";
- import { Measure } from "babylonjs-gui/2D/measure";
- import { Image } from "babylonjs-gui/2D/controls/image";
- import { Nullable } from 'babylonjs/types';
- /**
- * Class used to create slider controls based on images
- */
- export class ImageBasedSlider extends BaseSlider {
- name?: string | undefined;
- private _backgroundImage;
- private _thumbImage;
- private _valueBarImage;
- private _tempMeasure;
- get displayThumb(): boolean;
- set displayThumb(value: boolean);
- /**
- * Gets or sets the image used to render the background
- */
- get backgroundImage(): Image;
- set backgroundImage(value: Image);
- /**
- * Gets or sets the image used to render the value bar
- */
- get valueBarImage(): Image;
- set valueBarImage(value: Image);
- /**
- * Gets or sets the image used to render the thumb
- */
- get thumbImage(): Image;
- set thumbImage(value: Image);
- /**
- * Creates a new ImageBasedSlider
- * @param name defines the control name
- */
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: Nullable<Measure>): void;
- }
- }
- declare module "babylonjs-gui/2D/controls/statics" {
- /**
- * Forcing an export so that this code will execute
- * @hidden
- */
- const name = "Statics";
- export { name };
- }
- declare module "babylonjs-gui/2D/controls/index" {
- export * from "babylonjs-gui/2D/controls/button";
- export * from "babylonjs-gui/2D/controls/checkbox";
- export * from "babylonjs-gui/2D/controls/colorpicker";
- export * from "babylonjs-gui/2D/controls/container";
- export * from "babylonjs-gui/2D/controls/control";
- export * from "babylonjs-gui/2D/controls/ellipse";
- export * from "babylonjs-gui/2D/controls/grid";
- export * from "babylonjs-gui/2D/controls/image";
- export * from "babylonjs-gui/2D/controls/inputText";
- export * from "babylonjs-gui/2D/controls/inputPassword";
- export * from "babylonjs-gui/2D/controls/line";
- export * from "babylonjs-gui/2D/controls/multiLine";
- export * from "babylonjs-gui/2D/controls/radioButton";
- export * from "babylonjs-gui/2D/controls/stackPanel";
- export * from "babylonjs-gui/2D/controls/selector";
- export * from "babylonjs-gui/2D/controls/scrollViewers/scrollViewer";
- export * from "babylonjs-gui/2D/controls/textBlock";
- export * from "babylonjs-gui/2D/controls/virtualKeyboard";
- export * from "babylonjs-gui/2D/controls/rectangle";
- export * from "babylonjs-gui/2D/controls/displayGrid";
- export * from "babylonjs-gui/2D/controls/sliders/baseSlider";
- export * from "babylonjs-gui/2D/controls/sliders/slider";
- export * from "babylonjs-gui/2D/controls/sliders/imageBasedSlider";
- export * from "babylonjs-gui/2D/controls/sliders/scrollBar";
- export * from "babylonjs-gui/2D/controls/sliders/imageScrollBar";
- export * from "babylonjs-gui/2D/controls/statics";
- }
- declare module "babylonjs-gui/2D/adtInstrumentation" {
- import { PerfCounter } from "babylonjs/Misc/perfCounter";
- import { IDisposable } from "babylonjs/scene";
- import { AdvancedDynamicTexture } from "babylonjs-gui/2D/advancedDynamicTexture";
- /**
- * This class can be used to get instrumentation data from a AdvancedDynamicTexture object
- */
- export class AdvancedDynamicTextureInstrumentation implements IDisposable {
- /**
- * Define the instrumented AdvancedDynamicTexture.
- */
- texture: AdvancedDynamicTexture;
- private _captureRenderTime;
- private _renderTime;
- private _captureLayoutTime;
- private _layoutTime;
- private _onBeginRenderObserver;
- private _onEndRenderObserver;
- private _onBeginLayoutObserver;
- private _onEndLayoutObserver;
- /**
- * Gets the perf counter used to capture render time
- */
- get renderTimeCounter(): PerfCounter;
- /**
- * Gets the perf counter used to capture layout time
- */
- get layoutTimeCounter(): PerfCounter;
- /**
- * Enable or disable the render time capture
- */
- get captureRenderTime(): boolean;
- set captureRenderTime(value: boolean);
- /**
- * Enable or disable the layout time capture
- */
- get captureLayoutTime(): boolean;
- set captureLayoutTime(value: boolean);
- /**
- * Instantiates a new advanced dynamic texture instrumentation.
- * This class can be used to get instrumentation data from an AdvancedDynamicTexture object
- * @param texture Defines the AdvancedDynamicTexture to instrument
- */
- constructor(
- /**
- * Define the instrumented AdvancedDynamicTexture.
- */
- texture: AdvancedDynamicTexture);
- /**
- * Dispose and release associated resources.
- */
- dispose(): void;
- }
- }
- declare module "babylonjs-gui/2D/xmlLoader" {
- /**
- * Class used to load GUI via XML.
- */
- export class XmlLoader {
- private _nodes;
- private _nodeTypes;
- private _isLoaded;
- private _objectAttributes;
- private _parentClass;
- /**
- * Create a new xml loader
- * @param parentClass Sets the class context. Used when the loader is instanced inside a class and not in a global context
- */
- constructor(parentClass?: null);
- private _getChainElement;
- private _getClassAttribute;
- private _createGuiElement;
- private _parseGrid;
- private _parseElement;
- private _prepareSourceElement;
- private _parseElementsFromSource;
- private _parseXml;
- /**
- * Gets if the loading has finished.
- * @returns whether the loading has finished or not
- */
- isLoaded(): boolean;
- /**
- * Gets a loaded node / control by id.
- * @param id the Controls id set in the xml
- * @returns element of type Control
- */
- getNodeById(id: string): any;
- /**
- * Gets all loaded nodes / controls
- * @returns Array of controls
- */
- getNodes(): any;
- /**
- * Initiates the xml layout loading
- * @param xmlFile defines the xml layout to load
- * @param rootNode defines the node / control to use as a parent for the loaded layout controls.
- * @param callback defines the callback called on layout load.
- */
- loadLayout(xmlFile: any, rootNode: any, callback: any): void;
- }
- }
- declare module "babylonjs-gui/2D/index" {
- export * from "babylonjs-gui/2D/controls/index";
- export * from "babylonjs-gui/2D/advancedDynamicTexture";
- export * from "babylonjs-gui/2D/adtInstrumentation";
- export * from "babylonjs-gui/2D/math2D";
- export * from "babylonjs-gui/2D/measure";
- export * from "babylonjs-gui/2D/multiLinePoint";
- export * from "babylonjs-gui/2D/style";
- export * from "babylonjs-gui/2D/valueAndUnit";
- export * from "babylonjs-gui/2D/xmlLoader";
- }
- declare module "babylonjs-gui/3D/controls/container3D" {
- import { Nullable } from "babylonjs/types";
- import { TransformNode } from "babylonjs/Meshes/transformNode";
- import { Scene } from "babylonjs/scene";
- import { Control3D } from "babylonjs-gui/3D/controls/control3D";
- /**
- * Class used to create containers for controls
- */
- export class Container3D extends Control3D {
- private _blockLayout;
- /**
- * Gets the list of child controls
- */
- protected _children: Control3D[];
- /**
- * Gets the list of child controls
- */
- get children(): Array<Control3D>;
- /**
- * Gets or sets a boolean indicating if the layout must be blocked (default is false).
- * This is helpful to optimize layout operation when adding multiple children in a row
- */
- get blockLayout(): boolean;
- set blockLayout(value: boolean);
- /**
- * Creates a new container
- * @param name defines the container name
- */
- constructor(name?: string);
- /**
- * Force the container to update the layout. Please note that it will not take blockLayout property in account
- * @returns the current container
- */
- updateLayout(): Container3D;
- /**
- * Gets a boolean indicating if the given control is in the children of this control
- * @param control defines the control to check
- * @returns true if the control is in the child list
- */
- containsControl(control: Control3D): boolean;
- /**
- * Adds a control to the children of this control
- * @param control defines the control to add
- * @returns the current container
- */
- addControl(control: Control3D): Container3D;
- /**
- * This function will be called everytime a new control is added
- */
- protected _arrangeChildren(): void;
- protected _createNode(scene: Scene): Nullable<TransformNode>;
- /**
- * Removes a control from the children of this control
- * @param control defines the control to remove
- * @returns the current container
- */
- removeControl(control: Control3D): Container3D;
- protected _getTypeName(): string;
- /**
- * Releases all associated resources
- */
- dispose(): void;
- /** Control rotation will remain unchanged */
- static readonly UNSET_ORIENTATION: number;
- /** Control will rotate to make it look at sphere central axis */
- static readonly FACEORIGIN_ORIENTATION: number;
- /** Control will rotate to make it look back at sphere central axis */
- static readonly FACEORIGINREVERSED_ORIENTATION: number;
- /** Control will rotate to look at z axis (0, 0, 1) */
- static readonly FACEFORWARD_ORIENTATION: number;
- /** Control will rotate to look at negative z axis (0, 0, -1) */
- static readonly FACEFORWARDREVERSED_ORIENTATION: number;
- }
- }
- declare module "babylonjs-gui/3D/gui3DManager" {
- import { Nullable } from "babylonjs/types";
- import { Observable } from "babylonjs/Misc/observable";
- import { Vector3 } from "babylonjs/Maths/math.vector";
- import { Material } from "babylonjs/Materials/material";
- import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
- import { IDisposable, Scene } from "babylonjs/scene";
- import { Container3D } from "babylonjs-gui/3D/controls/container3D";
- import { Control3D } from "babylonjs-gui/3D/controls/control3D";
- /**
- * Class used to manage 3D user interface
- * @see https://doc.babylonjs.com/how_to/gui3d
- */
- export class GUI3DManager implements IDisposable {
- private _scene;
- private _sceneDisposeObserver;
- private _utilityLayer;
- private _rootContainer;
- private _pointerObserver;
- private _pointerOutObserver;
- /** @hidden */
- _lastPickedControl: Control3D;
- /** @hidden */
- _lastControlOver: {
- [pointerId: number]: Control3D;
- };
- /** @hidden */
- _lastControlDown: {
- [pointerId: number]: Control3D;
- };
- /**
- * Observable raised when the point picked by the pointer events changed
- */
- onPickedPointChangedObservable: Observable<Nullable<Vector3>>;
- /** @hidden */
- _sharedMaterials: {
- [key: string]: Material;
- };
- /** Gets the hosting scene */
- get scene(): Scene;
- /** Gets associated utility layer */
- get utilityLayer(): Nullable<UtilityLayerRenderer>;
- /**
- * Creates a new GUI3DManager
- * @param scene
- */
- constructor(scene?: Scene);
- private _handlePointerOut;
- private _doPicking;
- /**
- * Gets the root container
- */
- get rootContainer(): Container3D;
- /**
- * Gets a boolean indicating if the given control is in the root child list
- * @param control defines the control to check
- * @returns true if the control is in the root child list
- */
- containsControl(control: Control3D): boolean;
- /**
- * Adds a control to the root child list
- * @param control defines the control to add
- * @returns the current manager
- */
- addControl(control: Control3D): GUI3DManager;
- /**
- * Removes a control from the root child list
- * @param control defines the control to remove
- * @returns the current container
- */
- removeControl(control: Control3D): GUI3DManager;
- /**
- * Releases all associated resources
- */
- dispose(): void;
- }
- }
- declare module "babylonjs-gui/3D/vector3WithInfo" {
- import { Vector3 } from "babylonjs/Maths/math.vector";
- /**
- * Class used to transport Vector3 information for pointer events
- */
- export class Vector3WithInfo extends Vector3 {
- /** defines the current mouse button index */
- buttonIndex: number;
- /**
- * Creates a new Vector3WithInfo
- * @param source defines the vector3 data to transport
- * @param buttonIndex defines the current mouse button index
- */
- constructor(source: Vector3,
- /** defines the current mouse button index */
- buttonIndex?: number);
- }
- }
- declare module "babylonjs-gui/3D/controls/control3D" {
- import { Nullable } from "babylonjs/types";
- import { Observable } from "babylonjs/Misc/observable";
- import { Vector3 } from "babylonjs/Maths/math.vector";
- import { TransformNode } from "babylonjs/Meshes/transformNode";
- import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
- import { IBehaviorAware, Behavior } from "babylonjs/Behaviors/behavior";
- import { IDisposable, Scene } from "babylonjs/scene";
- import { GUI3DManager } from "babylonjs-gui/3D/gui3DManager";
- import { Vector3WithInfo } from "babylonjs-gui/3D/vector3WithInfo";
- import { Container3D } from "babylonjs-gui/3D/controls/container3D";
- /**
- * Class used as base class for controls
- */
- export class Control3D implements IDisposable, IBehaviorAware<Control3D> {
- /** Defines the control name */
- name?: string | undefined;
- /** @hidden */
- _host: GUI3DManager;
- private _node;
- private _downCount;
- private _enterCount;
- private _downPointerIds;
- private _isVisible;
- /** Gets or sets the control position in world space */
- get position(): Vector3;
- set position(value: Vector3);
- /** Gets or sets the control scaling in world space */
- get scaling(): Vector3;
- set scaling(value: Vector3);
- /** Callback used to start pointer enter animation */
- pointerEnterAnimation: () => void;
- /** Callback used to start pointer out animation */
- pointerOutAnimation: () => void;
- /** Callback used to start pointer down animation */
- pointerDownAnimation: () => void;
- /** Callback used to start pointer up animation */
- pointerUpAnimation: () => void;
- /**
- * An event triggered when the pointer move over the control
- */
- onPointerMoveObservable: Observable<Vector3>;
- /**
- * An event triggered when the pointer move out of the control
- */
- onPointerOutObservable: Observable<Control3D>;
- /**
- * An event triggered when the pointer taps the control
- */
- onPointerDownObservable: Observable<Vector3WithInfo>;
- /**
- * An event triggered when pointer is up
- */
- onPointerUpObservable: Observable<Vector3WithInfo>;
- /**
- * An event triggered when a control is clicked on (with a mouse)
- */
- onPointerClickObservable: Observable<Vector3WithInfo>;
- /**
- * An event triggered when pointer enters the control
- */
- onPointerEnterObservable: Observable<Control3D>;
- /**
- * Gets or sets the parent container
- */
- parent: Nullable<Container3D>;
- private _behaviors;
- /**
- * Gets the list of attached behaviors
- * @see https://doc.babylonjs.com/features/behaviour
- */
- get behaviors(): Behavior<Control3D>[];
- /**
- * Attach a behavior to the control
- * @see https://doc.babylonjs.com/features/behaviour
- * @param behavior defines the behavior to attach
- * @returns the current control
- */
- addBehavior(behavior: Behavior<Control3D>): Control3D;
- /**
- * Remove an attached behavior
- * @see https://doc.babylonjs.com/features/behaviour
- * @param behavior defines the behavior to attach
- * @returns the current control
- */
- removeBehavior(behavior: Behavior<Control3D>): Control3D;
- /**
- * Gets an attached behavior by name
- * @param name defines the name of the behavior to look for
- * @see https://doc.babylonjs.com/features/behaviour
- * @returns null if behavior was not found else the requested behavior
- */
- getBehaviorByName(name: string): Nullable<Behavior<Control3D>>;
- /** Gets or sets a boolean indicating if the control is visible */
- get isVisible(): boolean;
- set isVisible(value: boolean);
- /**
- * Creates a new control
- * @param name defines the control name
- */
- constructor(
- /** Defines the control name */
- name?: string | undefined);
- /**
- * Gets a string representing the class name
- */
- get typeName(): string;
- /**
- * Get the current class name of the control.
- * @returns current class name
- */
- getClassName(): string;
- protected _getTypeName(): string;
- /**
- * Gets the transform node used by this control
- */
- get node(): Nullable<TransformNode>;
- /**
- * Gets the mesh used to render this control
- */
- get mesh(): Nullable<AbstractMesh>;
- /**
- * Link the control as child of the given node
- * @param node defines the node to link to. Use null to unlink the control
- * @returns the current control
- */
- linkToTransformNode(node: Nullable<TransformNode>): Control3D;
- /** @hidden **/
- _prepareNode(scene: Scene): void;
- /**
- * Node creation.
- * Can be overriden by children
- * @param scene defines the scene where the node must be attached
- * @returns the attached node or null if none. Must return a Mesh or AbstractMesh if there is an atttached visible object
- */
- protected _createNode(scene: Scene): Nullable<TransformNode>;
- /**
- * Affect a material to the given mesh
- * @param mesh defines the mesh which will represent the control
- */
- protected _affectMaterial(mesh: AbstractMesh): void;
- /** @hidden */
- _onPointerMove(target: Control3D, coordinates: Vector3): void;
- /** @hidden */
- _onPointerEnter(target: Control3D): boolean;
- /** @hidden */
- _onPointerOut(target: Control3D): void;
- /** @hidden */
- _onPointerDown(target: Control3D, coordinates: Vector3, pointerId: number, buttonIndex: number): boolean;
- /** @hidden */
- _onPointerUp(target: Control3D, coordinates: Vector3, pointerId: number, buttonIndex: number, notifyClick: boolean): void;
- /** @hidden */
- forcePointerUp(pointerId?: Nullable<number>): void;
- /** @hidden */
- _processObservables(type: number, pickedPoint: Vector3, pointerId: number, buttonIndex: number): boolean;
- /** @hidden */
- _disposeNode(): void;
- /**
- * Releases all associated resources
- */
- dispose(): void;
- }
- }
- declare module "babylonjs-gui/3D/controls/abstractButton3D" {
- import { TransformNode } from "babylonjs/Meshes/transformNode";
- import { Scene } from "babylonjs/scene";
- import { Control3D } from "babylonjs-gui/3D/controls/control3D";
- /**
- * Class used as a root to all buttons
- */
- export class AbstractButton3D extends Control3D {
- /**
- * Creates a new button
- * @param name defines the control name
- */
- constructor(name?: string);
- protected _getTypeName(): string;
- protected _createNode(scene: Scene): TransformNode;
- }
- }
- declare module "babylonjs-gui/3D/controls/button3D" {
- import { int } from "babylonjs/types";
- import { TransformNode } from "babylonjs/Meshes/transformNode";
- import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
- import { Material } from "babylonjs/Materials/material";
- import { Scene } from "babylonjs/scene";
- import { AbstractButton3D } from "babylonjs-gui/3D/controls/abstractButton3D";
- import { AdvancedDynamicTexture } from "babylonjs-gui/2D/advancedDynamicTexture";
- import { Control } from "babylonjs-gui/2D/controls/control";
- /**
- * Class used to create a button in 3D
- */
- export class Button3D extends AbstractButton3D {
- /** @hidden */
- protected _currentMaterial: Material;
- private _facadeTexture;
- private _content;
- private _contentResolution;
- private _contentScaleRatio;
- /**
- * Gets or sets the texture resolution used to render content (512 by default)
- */
- get contentResolution(): int;
- set contentResolution(value: int);
- /**
- * Gets or sets the texture scale ratio used to render content (2 by default)
- */
- get contentScaleRatio(): number;
- set contentScaleRatio(value: number);
- protected _disposeFacadeTexture(): void;
- protected _resetContent(): void;
- /**
- * Creates a new button
- * @param name defines the control name
- */
- constructor(name?: string);
- /**
- * Gets or sets the GUI 2D content used to display the button's facade
- */
- get content(): Control;
- set content(value: Control);
- /**
- * Apply the facade texture (created from the content property).
- * This function can be overloaded by child classes
- * @param facadeTexture defines the AdvancedDynamicTexture to use
- */
- protected _applyFacade(facadeTexture: AdvancedDynamicTexture): void;
- protected _getTypeName(): string;
- protected _createNode(scene: Scene): TransformNode;
- protected _affectMaterial(mesh: AbstractMesh): void;
- /**
- * Releases all associated resources
- */
- dispose(): void;
- }
- }
- declare module "babylonjs-gui/3D/controls/volumeBasedPanel" {
- import { Vector3 } from "babylonjs/Maths/math.vector";
- import { int } from "babylonjs/types";
- import { Container3D } from "babylonjs-gui/3D/controls/container3D";
- import { Control3D } from "babylonjs-gui/3D/controls/control3D";
- /**
- * Abstract class used to create a container panel deployed on the surface of a volume
- */
- export abstract class VolumeBasedPanel extends Container3D {
- private _columns;
- private _rows;
- private _rowThenColum;
- private _orientation;
- protected _cellWidth: number;
- protected _cellHeight: number;
- /**
- * Gets or sets the distance between elements
- */
- margin: number;
- /**
- * Gets or sets the orientation to apply to all controls (BABYLON.Container3D.FaceOriginReversedOrientation by default)
- * | Value | Type | Description |
- * | ----- | ----------------------------------- | ----------- |
- * | 0 | UNSET_ORIENTATION | Control rotation will remain unchanged |
- * | 1 | FACEORIGIN_ORIENTATION | Control will rotate to make it look at sphere central axis |
- * | 2 | FACEORIGINREVERSED_ORIENTATION | Control will rotate to make it look back at sphere central axis |
- * | 3 | FACEFORWARD_ORIENTATION | Control will rotate to look at z axis (0, 0, 1) |
- * | 4 | FACEFORWARDREVERSED_ORIENTATION | Control will rotate to look at negative z axis (0, 0, -1) |
- */
- get orientation(): number;
- set orientation(value: number);
- /**
- * Gets or sets the number of columns requested (10 by default).
- * The panel will automatically compute the number of rows based on number of child controls.
- */
- get columns(): int;
- set columns(value: int);
- /**
- * Gets or sets a the number of rows requested.
- * The panel will automatically compute the number of columns based on number of child controls.
- */
- get rows(): int;
- set rows(value: int);
- /**
- * Creates new VolumeBasedPanel
- */
- constructor();
- protected _arrangeChildren(): void;
- /** Child classes must implement this function to provide correct control positioning */
- protected abstract _mapGridNode(control: Control3D, nodePosition: Vector3): void;
- /** Child classes can implement this function to provide additional processing */
- protected _finalProcessing(): void;
- }
- }
- declare module "babylonjs-gui/3D/controls/cylinderPanel" {
- import { Vector3 } from "babylonjs/Maths/math.vector";
- import { float } from "babylonjs/types";
- import { VolumeBasedPanel } from "babylonjs-gui/3D/controls/volumeBasedPanel";
- import { Control3D } from "babylonjs-gui/3D/controls/control3D";
- /**
- * Class used to create a container panel deployed on the surface of a cylinder
- */
- export class CylinderPanel extends VolumeBasedPanel {
- private _radius;
- /**
- * Gets or sets the radius of the cylinder where to project controls (5 by default)
- */
- get radius(): float;
- set radius(value: float);
- protected _mapGridNode(control: Control3D, nodePosition: Vector3): void;
- private _cylindricalMapping;
- }
- }
- declare module "babylonjs-gui/3D/materials/shaders/fluent.vertex" {
- /** @hidden */
- export var fluentVertexShader: {
- name: string;
- shader: string;
- };
- }
- declare module "babylonjs-gui/3D/materials/shaders/fluent.fragment" {
- /** @hidden */
- export var fluentPixelShader: {
- name: string;
- shader: string;
- };
- }
- declare module "babylonjs-gui/3D/materials/fluentMaterial" {
- import { Nullable } from "babylonjs/types";
- import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
- import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
- import { MaterialDefines } from "babylonjs/Materials/materialDefines";
- import { PushMaterial } from "babylonjs/Materials/pushMaterial";
- import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
- import { SubMesh } from "babylonjs/Meshes/subMesh";
- import { Mesh } from "babylonjs/Meshes/mesh";
- import { Scene } from "babylonjs/scene";
- import { Color3, Color4 } from 'babylonjs/Maths/math.color';
- import "babylonjs-gui/3D/materials/shaders/fluent.vertex";
- import "babylonjs-gui/3D/materials/shaders/fluent.fragment";
- /** @hidden */
- export class FluentMaterialDefines extends MaterialDefines {
- INNERGLOW: boolean;
- BORDER: boolean;
- HOVERLIGHT: boolean;
- TEXTURE: boolean;
- constructor();
- }
- /**
- * Class used to render controls with fluent desgin
- */
- export class FluentMaterial extends PushMaterial {
- /**
- * Gets or sets inner glow intensity. A value of 0 means no glow (default is 0.5)
- */
- innerGlowColorIntensity: number;
- /**
- * Gets or sets the inner glow color (white by default)
- */
- innerGlowColor: Color3;
- /**
- * Gets or sets the albedo color (Default is Color3(0.3, 0.35, 0.4))
- */
- albedoColor: Color3;
- /**
- * Gets or sets a boolean indicating if borders must be rendered (default is false)
- */
- renderBorders: boolean;
- /**
- * Gets or sets border width (default is 0.5)
- */
- borderWidth: number;
- /**
- * Gets or sets a value indicating the smoothing value applied to border edges (0.02 by default)
- */
- edgeSmoothingValue: number;
- /**
- * Gets or sets the minimum value that can be applied to border width (default is 0.1)
- */
- borderMinValue: number;
- /**
- * Gets or sets a boolean indicating if hover light must be rendered (default is false)
- */
- renderHoverLight: boolean;
- /**
- * Gets or sets the radius used to render the hover light (default is 1.0)
- */
- hoverRadius: number;
- /**
- * Gets or sets the color used to render the hover light (default is Color4(0.3, 0.3, 0.3, 1.0))
- */
- hoverColor: Color4;
- /**
- * Gets or sets the hover light position in world space (default is Vector3.Zero())
- */
- hoverPosition: Vector3;
- private _albedoTexture;
- /** Gets or sets the texture to use for albedo color */
- albedoTexture: Nullable<BaseTexture>;
- /**
- * Creates a new Fluent material
- * @param name defines the name of the material
- * @param scene defines the hosting scene
- */
- constructor(name: string, scene: Scene);
- needAlphaBlending(): boolean;
- needAlphaTesting(): boolean;
- getAlphaTestTexture(): Nullable<BaseTexture>;
- isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
- bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
- getActiveTextures(): BaseTexture[];
- hasTexture(texture: BaseTexture): boolean;
- dispose(forceDisposeEffect?: boolean): void;
- clone(name: string): FluentMaterial;
- serialize(): any;
- getClassName(): string;
- static Parse(source: any, scene: Scene, rootUrl: string): FluentMaterial;
- }
- }
- declare module "babylonjs-gui/3D/controls/holographicButton" {
- import { Button3D } from "babylonjs-gui/3D/controls/button3D";
- import { Nullable } from "babylonjs/types";
- import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
- import { TransformNode } from "babylonjs/Meshes/transformNode";
- import { Mesh } from "babylonjs/Meshes/mesh";
- import { Scene } from "babylonjs/scene";
- import { FluentMaterial } from "babylonjs-gui/3D/materials/fluentMaterial";
- import { AdvancedDynamicTexture } from "babylonjs-gui/2D/advancedDynamicTexture";
- /**
- * Class used to create a holographic button in 3D
- */
- export class HolographicButton extends Button3D {
- private _backPlate;
- private _textPlate;
- private _frontPlate;
- private _text;
- private _imageUrl;
- private _shareMaterials;
- private _frontMaterial;
- private _backMaterial;
- private _plateMaterial;
- private _pickedPointObserver;
- private _tooltipFade;
- private _tooltipTextBlock;
- private _tooltipTexture;
- private _tooltipMesh;
- private _tooltipHoverObserver;
- private _tooltipOutObserver;
- private _disposeTooltip;
- /**
- * Rendering ground id of all the mesh in the button
- */
- set renderingGroupId(id: number);
- get renderingGroupId(): number;
- /**
- * Text to be displayed on the tooltip shown when hovering on the button. When set to null tooltip is disabled. (Default: null)
- */
- set tooltipText(text: Nullable<string>);
- get tooltipText(): Nullable<string>;
- /**
- * Gets or sets text for the button
- */
- get text(): string;
- set text(value: string);
- /**
- * Gets or sets the image url for the button
- */
- get imageUrl(): string;
- set imageUrl(value: string);
- /**
- * Gets the back material used by this button
- */
- get backMaterial(): FluentMaterial;
- /**
- * Gets the front material used by this button
- */
- get frontMaterial(): FluentMaterial;
- /**
- * Gets the plate material used by this button
- */
- get plateMaterial(): StandardMaterial;
- /**
- * Gets a boolean indicating if this button shares its material with other HolographicButtons
- */
- get shareMaterials(): boolean;
- /**
- * Creates a new button
- * @param name defines the control name
- */
- constructor(name?: string, shareMaterials?: boolean);
- protected _getTypeName(): string;
- private _rebuildContent;
- protected _createNode(scene: Scene): TransformNode;
- protected _applyFacade(facadeTexture: AdvancedDynamicTexture): void;
- private _createBackMaterial;
- private _createFrontMaterial;
- private _createPlateMaterial;
- protected _affectMaterial(mesh: Mesh): void;
- /**
- * Releases all associated resources
- */
- dispose(): void;
- }
- }
- declare module "babylonjs-gui/3D/controls/meshButton3D" {
- import { TransformNode } from "babylonjs/Meshes/transformNode";
- import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
- import { Mesh } from "babylonjs/Meshes/mesh";
- import { Scene } from "babylonjs/scene";
- import { Button3D } from "babylonjs-gui/3D/controls/button3D";
- /**
- * Class used to create an interactable object. It's a 3D button using a mesh coming from the current scene
- */
- export class MeshButton3D extends Button3D {
- /** @hidden */
- protected _currentMesh: Mesh;
- /**
- * Creates a new 3D button based on a mesh
- * @param mesh mesh to become a 3D button
- * @param name defines the control name
- */
- constructor(mesh: Mesh, name?: string);
- protected _getTypeName(): string;
- protected _createNode(scene: Scene): TransformNode;
- protected _affectMaterial(mesh: AbstractMesh): void;
- }
- }
- declare module "babylonjs-gui/3D/controls/planePanel" {
- import { Vector3 } from "babylonjs/Maths/math.vector";
- import { Control3D } from "babylonjs-gui/3D/controls/control3D";
- import { VolumeBasedPanel } from "babylonjs-gui/3D/controls/volumeBasedPanel";
- /**
- * Class used to create a container panel deployed on the surface of a plane
- */
- export class PlanePanel extends VolumeBasedPanel {
- protected _mapGridNode(control: Control3D, nodePosition: Vector3): void;
- }
- }
- declare module "babylonjs-gui/3D/controls/scatterPanel" {
- import { Vector3 } from "babylonjs/Maths/math.vector";
- import { float } from "babylonjs/types";
- import { VolumeBasedPanel } from "babylonjs-gui/3D/controls/volumeBasedPanel";
- import { Control3D } from "babylonjs-gui/3D/controls/control3D";
- /**
- * Class used to create a container panel where items get randomized planar mapping
- */
- export class ScatterPanel extends VolumeBasedPanel {
- private _iteration;
- /**
- * Gets or sets the number of iteration to use to scatter the controls (100 by default)
- */
- get iteration(): float;
- set iteration(value: float);
- protected _mapGridNode(control: Control3D, nodePosition: Vector3): void;
- private _scatterMapping;
- protected _finalProcessing(): void;
- }
- }
- declare module "babylonjs-gui/3D/controls/spherePanel" {
- import { Vector3 } from "babylonjs/Maths/math.vector";
- import { float } from "babylonjs/types";
- import { VolumeBasedPanel } from "babylonjs-gui/3D/controls/volumeBasedPanel";
- import { Control3D } from "babylonjs-gui/3D/controls/control3D";
- /**
- * Class used to create a container panel deployed on the surface of a sphere
- */
- export class SpherePanel extends VolumeBasedPanel {
- private _radius;
- /**
- * Gets or sets the radius of the sphere where to project controls (5 by default)
- */
- get radius(): float;
- set radius(value: float);
- protected _mapGridNode(control: Control3D, nodePosition: Vector3): void;
- private _sphericalMapping;
- }
- }
- declare module "babylonjs-gui/3D/controls/stackPanel3D" {
- import { Container3D } from "babylonjs-gui/3D/controls/container3D";
- /**
- * Class used to create a stack panel in 3D on XY plane
- */
- export class StackPanel3D extends Container3D {
- private _isVertical;
- /**
- * Gets or sets a boolean indicating if the stack panel is vertical or horizontal (horizontal by default)
- */
- get isVertical(): boolean;
- set isVertical(value: boolean);
- /**
- * Gets or sets the distance between elements
- */
- margin: number;
- /**
- * Creates new StackPanel
- * @param isVertical
- */
- constructor(isVertical?: boolean);
- protected _arrangeChildren(): void;
- }
- }
- declare module "babylonjs-gui/3D/controls/index" {
- export * from "babylonjs-gui/3D/controls/abstractButton3D";
- export * from "babylonjs-gui/3D/controls/button3D";
- export * from "babylonjs-gui/3D/controls/container3D";
- export * from "babylonjs-gui/3D/controls/control3D";
- export * from "babylonjs-gui/3D/controls/cylinderPanel";
- export * from "babylonjs-gui/3D/controls/holographicButton";
- export * from "babylonjs-gui/3D/controls/meshButton3D";
- export * from "babylonjs-gui/3D/controls/planePanel";
- export * from "babylonjs-gui/3D/controls/scatterPanel";
- export * from "babylonjs-gui/3D/controls/spherePanel";
- export * from "babylonjs-gui/3D/controls/stackPanel3D";
- export * from "babylonjs-gui/3D/controls/volumeBasedPanel";
- }
- declare module "babylonjs-gui/3D/materials/index" {
- export * from "babylonjs-gui/3D/materials/fluentMaterial";
- }
- declare module "babylonjs-gui/3D/index" {
- export * from "babylonjs-gui/3D/controls/index";
- export * from "babylonjs-gui/3D/materials/index";
- export * from "babylonjs-gui/3D/gui3DManager";
- export * from "babylonjs-gui/3D/vector3WithInfo";
- }
- declare module "babylonjs-gui/index" {
- export * from "babylonjs-gui/2D/index";
- export * from "babylonjs-gui/3D/index";
- }
- declare module "babylonjs-gui/legacy/legacy" {
- export * from "babylonjs-gui/index";
- }
- declare module "babylonjs-gui" {
- export * from "babylonjs-gui/legacy/legacy";
- }
- declare module BABYLON.GUI {
- /**
- * Class used to specific a value and its associated unit
- */
- export class ValueAndUnit {
- /** defines the unit to store */
- unit: number;
- /** defines a boolean indicating if the value can be negative */
- negativeValueAllowed: boolean;
- private _value;
- private _originalUnit;
- /**
- * Gets or sets a value indicating that this value will not scale accordingly with adaptive scaling property
- * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
- */
- ignoreAdaptiveScaling: boolean;
- /**
- * Creates a new ValueAndUnit
- * @param value defines the value to store
- * @param unit defines the unit to store
- * @param negativeValueAllowed defines a boolean indicating if the value can be negative
- */
- constructor(value: number,
- /** defines the unit to store */
- unit?: number,
- /** defines a boolean indicating if the value can be negative */
- negativeValueAllowed?: boolean);
- /** Gets a boolean indicating if the value is a percentage */
- get isPercentage(): boolean;
- /** Gets a boolean indicating if the value is store as pixel */
- get isPixel(): boolean;
- /** Gets direct internal value */
- get internalValue(): number;
- /**
- * Gets value as pixel
- * @param host defines the root host
- * @param refValue defines the reference value for percentages
- * @returns the value as pixel
- */
- getValueInPixel(host: AdvancedDynamicTexture, refValue: number): number;
- /**
- * Update the current value and unit. This should be done cautiously as the GUi won't be marked as dirty with this function.
- * @param value defines the value to store
- * @param unit defines the unit to store
- * @returns the current ValueAndUnit
- */
- updateInPlace(value: number, unit?: number): ValueAndUnit;
- /**
- * Gets the value accordingly to its unit
- * @param host defines the root host
- * @returns the value
- */
- getValue(host: AdvancedDynamicTexture): number;
- /**
- * Gets a string representation of the value
- * @param host defines the root host
- * @param decimals defines an optional number of decimals to display
- * @returns a string
- */
- toString(host: AdvancedDynamicTexture, decimals?: number): string;
- /**
- * Store a value parsed from a string
- * @param source defines the source string
- * @returns true if the value was successfully parsed
- */
- fromString(source: string | number): boolean;
- private static _Regex;
- private static _UNITMODE_PERCENTAGE;
- private static _UNITMODE_PIXEL;
- /** UNITMODE_PERCENTAGE */
- static get UNITMODE_PERCENTAGE(): number;
- /** UNITMODE_PIXEL */
- static get UNITMODE_PIXEL(): number;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Define a style used by control to automatically setup properties based on a template.
- * Only support font related properties so far
- */
- export class Style implements BABYLON.IDisposable {
- private _fontFamily;
- private _fontStyle;
- private _fontWeight;
- /** @hidden */
- _host: AdvancedDynamicTexture;
- /** @hidden */
- _fontSize: ValueAndUnit;
- /**
- * BABYLON.Observable raised when the style values are changed
- */
- onChangedObservable: BABYLON.Observable<Style>;
- /**
- * Creates a new style object
- * @param host defines the AdvancedDynamicTexture which hosts this style
- */
- constructor(host: AdvancedDynamicTexture);
- /**
- * Gets or sets the font size
- */
- get fontSize(): string | number;
- set fontSize(value: string | number);
- /**
- * Gets or sets the font family
- */
- get fontFamily(): string;
- set fontFamily(value: string);
- /**
- * Gets or sets the font style
- */
- get fontStyle(): string;
- set fontStyle(value: string);
- /** Gets or sets font weight */
- get fontWeight(): string;
- set fontWeight(value: string);
- /** Dispose all associated resources */
- dispose(): void;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to transport BABYLON.Vector2 information for pointer events
- */
- export class Vector2WithInfo extends BABYLON.Vector2 {
- /** defines the current mouse button index */
- buttonIndex: number;
- /**
- * Creates a new Vector2WithInfo
- * @param source defines the vector2 data to transport
- * @param buttonIndex defines the current mouse button index
- */
- constructor(source: BABYLON.Vector2,
- /** defines the current mouse button index */
- buttonIndex?: number);
- }
- /** Class used to provide 2D matrix features */
- export class Matrix2D {
- /** Gets the internal array of 6 floats used to store matrix data */
- m: Float32Array;
- /**
- * Creates a new matrix
- * @param m00 defines value for (0, 0)
- * @param m01 defines value for (0, 1)
- * @param m10 defines value for (1, 0)
- * @param m11 defines value for (1, 1)
- * @param m20 defines value for (2, 0)
- * @param m21 defines value for (2, 1)
- */
- constructor(m00: number, m01: number, m10: number, m11: number, m20: number, m21: number);
- /**
- * Fills the matrix from direct values
- * @param m00 defines value for (0, 0)
- * @param m01 defines value for (0, 1)
- * @param m10 defines value for (1, 0)
- * @param m11 defines value for (1, 1)
- * @param m20 defines value for (2, 0)
- * @param m21 defines value for (2, 1)
- * @returns the current modified matrix
- */
- fromValues(m00: number, m01: number, m10: number, m11: number, m20: number, m21: number): Matrix2D;
- /**
- * Gets matrix determinant
- * @returns the determinant
- */
- determinant(): number;
- /**
- * Inverses the matrix and stores it in a target matrix
- * @param result defines the target matrix
- * @returns the current matrix
- */
- invertToRef(result: Matrix2D): Matrix2D;
- /**
- * Multiplies the current matrix with another one
- * @param other defines the second operand
- * @param result defines the target matrix
- * @returns the current matrix
- */
- multiplyToRef(other: Matrix2D, result: Matrix2D): Matrix2D;
- /**
- * Applies the current matrix to a set of 2 floats and stores the result in a vector2
- * @param x defines the x coordinate to transform
- * @param y defines the x coordinate to transform
- * @param result defines the target vector2
- * @returns the current matrix
- */
- transformCoordinates(x: number, y: number, result: BABYLON.Vector2): Matrix2D;
- /**
- * Creates an identity matrix
- * @returns a new matrix
- */
- static Identity(): Matrix2D;
- /**
- * Creates a translation matrix and stores it in a target matrix
- * @param x defines the x coordinate of the translation
- * @param y defines the y coordinate of the translation
- * @param result defines the target matrix
- */
- static TranslationToRef(x: number, y: number, result: Matrix2D): void;
- /**
- * Creates a scaling matrix and stores it in a target matrix
- * @param x defines the x coordinate of the scaling
- * @param y defines the y coordinate of the scaling
- * @param result defines the target matrix
- */
- static ScalingToRef(x: number, y: number, result: Matrix2D): void;
- /**
- * Creates a rotation matrix and stores it in a target matrix
- * @param angle defines the rotation angle
- * @param result defines the target matrix
- */
- static RotationToRef(angle: number, result: Matrix2D): void;
- private static _TempPreTranslationMatrix;
- private static _TempPostTranslationMatrix;
- private static _TempRotationMatrix;
- private static _TempScalingMatrix;
- private static _TempCompose0;
- private static _TempCompose1;
- private static _TempCompose2;
- /**
- * Composes a matrix from translation, rotation, scaling and parent matrix and stores it in a target matrix
- * @param tx defines the x coordinate of the translation
- * @param ty defines the y coordinate of the translation
- * @param angle defines the rotation angle
- * @param scaleX defines the x coordinate of the scaling
- * @param scaleY defines the y coordinate of the scaling
- * @param parentMatrix defines the parent matrix to multiply by (can be null)
- * @param result defines the target matrix
- */
- static ComposeToRef(tx: number, ty: number, angle: number, scaleX: number, scaleY: number, parentMatrix: BABYLON.Nullable<Matrix2D>, result: Matrix2D): void;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to store 2D control sizes
- */
- export class Measure {
- /** defines left coordinate */
- left: number;
- /** defines top coordinate */
- top: number;
- /** defines width dimension */
- width: number;
- /** defines height dimension */
- height: number;
- /**
- * Creates a new measure
- * @param left defines left coordinate
- * @param top defines top coordinate
- * @param width defines width dimension
- * @param height defines height dimension
- */
- constructor(
- /** defines left coordinate */
- left: number,
- /** defines top coordinate */
- top: number,
- /** defines width dimension */
- width: number,
- /** defines height dimension */
- height: number);
- /**
- * Copy from another measure
- * @param other defines the other measure to copy from
- */
- copyFrom(other: Measure): void;
- /**
- * Copy from a group of 4 floats
- * @param left defines left coordinate
- * @param top defines top coordinate
- * @param width defines width dimension
- * @param height defines height dimension
- */
- copyFromFloats(left: number, top: number, width: number, height: number): void;
- /**
- * Computes the axis aligned bounding box measure for two given measures
- * @param a Input measure
- * @param b Input measure
- * @param result the resulting bounding measure
- */
- static CombineToRef(a: Measure, b: Measure, result: Measure): void;
- /**
- * Computes the axis aligned bounding box of the measure after it is modified by a given transform
- * @param transform the matrix to transform the measure before computing the AABB
- * @param addX number to add to left
- * @param addY number to add to top
- * @param addWidth number to add to width
- * @param addHeight number to add to height
- * @param result the resulting AABB
- */
- addAndTransformToRef(transform: Matrix2D, addX: number, addY: number, addWidth: number, addHeight: number, result: Measure): void;
- /**
- * Computes the axis aligned bounding box of the measure after it is modified by a given transform
- * @param transform the matrix to transform the measure before computing the AABB
- * @param result the resulting AABB
- */
- transformToRef(transform: Matrix2D, result: Measure): void;
- /**
- * Check equality between this measure and another one
- * @param other defines the other measures
- * @returns true if both measures are equals
- */
- isEqualsTo(other: Measure): boolean;
- /**
- * Creates an empty measure
- * @returns a new measure
- */
- static Empty(): Measure;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Interface used to define a control that can receive focus
- */
- export interface IFocusableControl {
- /**
- * Function called when the control receives the focus
- */
- onFocus(): void;
- /**
- * Function called when the control loses the focus
- */
- onBlur(): void;
- /**
- * Function called to let the control handle keyboard events
- * @param evt defines the current keyboard event
- */
- processKeyboard(evt: KeyboardEvent): void;
- /**
- * Function called to get the list of controls that should not steal the focus from this control
- * @returns an array of controls
- */
- keepsFocusWith(): BABYLON.Nullable<Control[]>;
- }
- /**
- * Class used to create texture to support 2D GUI elements
- * @see https://doc.babylonjs.com/how_to/gui
- */
- export class AdvancedDynamicTexture extends BABYLON.DynamicTexture {
- private _isDirty;
- private _renderObserver;
- private _resizeObserver;
- private _preKeyboardObserver;
- private _pointerMoveObserver;
- private _pointerObserver;
- private _canvasPointerOutObserver;
- private _canvasBlurObserver;
- private _background;
- /** @hidden */
- _rootContainer: Container;
- /** @hidden */
- _lastPickedControl: Control;
- /** @hidden */
- _lastControlOver: {
- [pointerId: number]: Control;
- };
- /** @hidden */
- _lastControlDown: {
- [pointerId: number]: Control;
- };
- /** @hidden */
- _capturingControl: {
- [pointerId: number]: Control;
- };
- /** @hidden */
- _shouldBlockPointer: boolean;
- /** @hidden */
- _layerToDispose: BABYLON.Nullable<BABYLON.Layer>;
- /** @hidden */
- _linkedControls: Control[];
- private _isFullscreen;
- private _fullscreenViewport;
- private _idealWidth;
- private _idealHeight;
- private _useSmallestIdeal;
- private _renderAtIdealSize;
- private _focusedControl;
- private _blockNextFocusCheck;
- private _renderScale;
- private _rootElement;
- private _cursorChanged;
- private _defaultMousePointerId;
- /** @hidden */
- _numLayoutCalls: number;
- /** Gets the number of layout calls made the last time the ADT has been rendered */
- get numLayoutCalls(): number;
- /** @hidden */
- _numRenderCalls: number;
- /** Gets the number of render calls made the last time the ADT has been rendered */
- get numRenderCalls(): number;
- /**
- * Define type to string to ensure compatibility across browsers
- * Safari doesn't support DataTransfer constructor
- */
- private _clipboardData;
- /**
- * BABYLON.Observable event triggered each time an clipboard event is received from the rendering canvas
- */
- onClipboardObservable: BABYLON.Observable<BABYLON.ClipboardInfo>;
- /**
- * BABYLON.Observable event triggered each time a pointer down is intercepted by a control
- */
- onControlPickedObservable: BABYLON.Observable<Control>;
- /**
- * BABYLON.Observable event triggered before layout is evaluated
- */
- onBeginLayoutObservable: BABYLON.Observable<AdvancedDynamicTexture>;
- /**
- * BABYLON.Observable event triggered after the layout was evaluated
- */
- onEndLayoutObservable: BABYLON.Observable<AdvancedDynamicTexture>;
- /**
- * BABYLON.Observable event triggered before the texture is rendered
- */
- onBeginRenderObservable: BABYLON.Observable<AdvancedDynamicTexture>;
- /**
- * BABYLON.Observable event triggered after the texture was rendered
- */
- onEndRenderObservable: BABYLON.Observable<AdvancedDynamicTexture>;
- /**
- * Gets or sets a boolean defining if alpha is stored as premultiplied
- */
- premulAlpha: boolean;
- /**
- * Gets or sets a number used to scale rendering size (2 means that the texture will be twice bigger).
- * Useful when you want more antialiasing
- */
- get renderScale(): number;
- set renderScale(value: number);
- /** Gets or sets the background color */
- get background(): string;
- set background(value: string);
- /**
- * Gets or sets the ideal width used to design controls.
- * The GUI will then rescale everything accordingly
- * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
- */
- get idealWidth(): number;
- set idealWidth(value: number);
- /**
- * Gets or sets the ideal height used to design controls.
- * The GUI will then rescale everything accordingly
- * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
- */
- get idealHeight(): number;
- set idealHeight(value: number);
- /**
- * Gets or sets a boolean indicating if the smallest ideal value must be used if idealWidth and idealHeight are both set
- * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
- */
- get useSmallestIdeal(): boolean;
- set useSmallestIdeal(value: boolean);
- /**
- * Gets or sets a boolean indicating if adaptive scaling must be used
- * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
- */
- get renderAtIdealSize(): boolean;
- set renderAtIdealSize(value: boolean);
- /**
- * Gets the ratio used when in "ideal mode"
- * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
- * */
- get idealRatio(): number;
- /**
- * Gets the underlying layer used to render the texture when in fullscreen mode
- */
- get layer(): BABYLON.Nullable<BABYLON.Layer>;
- /**
- * Gets the root container control
- */
- get rootContainer(): Container;
- /**
- * Returns an array containing the root container.
- * This is mostly used to let the Inspector introspects the ADT
- * @returns an array containing the rootContainer
- */
- getChildren(): Array<Container>;
- /**
- * Will return all controls that are inside this texture
- * @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
- * @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
- * @return all child controls
- */
- getDescendants(directDescendantsOnly?: boolean, predicate?: (control: Control) => boolean): Control[];
- /**
- * Gets or sets the current focused control
- */
- get focusedControl(): BABYLON.Nullable<IFocusableControl>;
- set focusedControl(control: BABYLON.Nullable<IFocusableControl>);
- /**
- * Gets or sets a boolean indicating if the texture must be rendered in background or foreground when in fullscreen mode
- */
- get isForeground(): boolean;
- set isForeground(value: boolean);
- /**
- * Gets or set information about clipboardData
- */
- get clipboardData(): string;
- set clipboardData(value: string);
- /**
- * Creates a new AdvancedDynamicTexture
- * @param name defines the name of the texture
- * @param width defines the width of the texture
- * @param height defines the height of the texture
- * @param scene defines the hosting scene
- * @param generateMipMaps defines a boolean indicating if mipmaps must be generated (false by default)
- * @param samplingMode defines the texture sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
- * @param invertY defines if the texture needs to be inverted on the y axis during loading (true by default)
- */
- constructor(name: string, width: number | undefined, height: number | undefined, scene: BABYLON.Nullable<BABYLON.Scene>, generateMipMaps?: boolean, samplingMode?: number, invertY?: boolean);
- /**
- * Get the current class name of the texture useful for serialization or dynamic coding.
- * @returns "AdvancedDynamicTexture"
- */
- getClassName(): string;
- /**
- * Function used to execute a function on all controls
- * @param func defines the function to execute
- * @param container defines the container where controls belong. If null the root container will be used
- */
- executeOnAllControls(func: (control: Control) => void, container?: Container): void;
- private _useInvalidateRectOptimization;
- /**
- * Gets or sets a boolean indicating if the InvalidateRect optimization should be turned on
- */
- get useInvalidateRectOptimization(): boolean;
- set useInvalidateRectOptimization(value: boolean);
- private _invalidatedRectangle;
- /**
- * Invalidates a rectangle area on the gui texture
- * @param invalidMinX left most position of the rectangle to invalidate in the texture
- * @param invalidMinY top most position of the rectangle to invalidate in the texture
- * @param invalidMaxX right most position of the rectangle to invalidate in the texture
- * @param invalidMaxY bottom most position of the rectangle to invalidate in the texture
- */
- invalidateRect(invalidMinX: number, invalidMinY: number, invalidMaxX: number, invalidMaxY: number): void;
- /**
- * Marks the texture as dirty forcing a complete update
- */
- markAsDirty(): void;
- /**
- * Helper function used to create a new style
- * @returns a new style
- * @see https://doc.babylonjs.com/how_to/gui#styles
- */
- createStyle(): Style;
- /**
- * Adds a new control to the root container
- * @param control defines the control to add
- * @returns the current texture
- */
- addControl(control: Control): AdvancedDynamicTexture;
- /**
- * Removes a control from the root container
- * @param control defines the control to remove
- * @returns the current texture
- */
- removeControl(control: Control): AdvancedDynamicTexture;
- /**
- * Release all resources
- */
- dispose(): void;
- private _onResize;
- /** @hidden */
- _getGlobalViewport(scene: BABYLON.Scene): BABYLON.Viewport;
- /**
- * Get screen coordinates for a vector3
- * @param position defines the position to project
- * @param worldMatrix defines the world matrix to use
- * @returns the projected position
- */
- getProjectedPosition(position: BABYLON.Vector3, worldMatrix: BABYLON.Matrix): BABYLON.Vector2;
- private _checkUpdate;
- private _clearMeasure;
- private _render;
- /** @hidden */
- _changeCursor(cursor: string): void;
- /** @hidden */
- _registerLastControlDown(control: Control, pointerId: number): void;
- private _doPicking;
- /** @hidden */
- _cleanControlAfterRemovalFromList(list: {
- [pointerId: number]: Control;
- }, control: Control): void;
- /** @hidden */
- _cleanControlAfterRemoval(control: Control): void;
- /** Attach to all scene events required to support pointer events */
- attach(): void;
- /** @hidden */
- private onClipboardCopy;
- /** @hidden */
- private onClipboardCut;
- /** @hidden */
- private onClipboardPaste;
- /**
- * Register the clipboard Events onto the canvas
- */
- registerClipboardEvents(): void;
- /**
- * Unregister the clipboard Events from the canvas
- */
- unRegisterClipboardEvents(): void;
- /**
- * Connect the texture to a hosting mesh to enable interactions
- * @param mesh defines the mesh to attach to
- * @param supportPointerMove defines a boolean indicating if pointer move events must be catched as well
- */
- attachToMesh(mesh: BABYLON.AbstractMesh, supportPointerMove?: boolean): void;
- /**
- * Move the focus to a specific control
- * @param control defines the control which will receive the focus
- */
- moveFocusToControl(control: IFocusableControl): void;
- private _manageFocus;
- private _attachToOnPointerOut;
- private _attachToOnBlur;
- /**
- * Creates a new AdvancedDynamicTexture in projected mode (ie. attached to a mesh)
- * @param mesh defines the mesh which will receive the texture
- * @param width defines the texture width (1024 by default)
- * @param height defines the texture height (1024 by default)
- * @param supportPointerMove defines a boolean indicating if the texture must capture move events (true by default)
- * @param onlyAlphaTesting defines a boolean indicating that alpha blending will not be used (only alpha testing) (false by default)
- * @param invertY defines if the texture needs to be inverted on the y axis during loading (true by default)
- * @returns a new AdvancedDynamicTexture
- */
- static CreateForMesh(mesh: BABYLON.AbstractMesh, width?: number, height?: number, supportPointerMove?: boolean, onlyAlphaTesting?: boolean, invertY?: boolean): AdvancedDynamicTexture;
- /**
- * Creates a new AdvancedDynamicTexture in fullscreen mode.
- * In this mode the texture will rely on a layer for its rendering.
- * This allows it to be treated like any other layer.
- * As such, if you have a multi camera setup, you can set the layerMask on the GUI as well.
- * LayerMask is set through advancedTexture.layer.layerMask
- * @param name defines name for the texture
- * @param foreground defines a boolean indicating if the texture must be rendered in foreground (default is true)
- * @param scene defines the hsoting scene
- * @param sampling defines the texture sampling mode (Texture.BILINEAR_SAMPLINGMODE by default)
- * @returns a new AdvancedDynamicTexture
- */
- static CreateFullscreenUI(name: string, foreground?: boolean, scene?: BABYLON.Nullable<BABYLON.Scene>, sampling?: number): AdvancedDynamicTexture;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Root class used for all 2D controls
- * @see https://doc.babylonjs.com/how_to/gui#controls
- */
- export class Control {
- /** defines the name of the control */
- name?: string | undefined;
- /**
- * Gets or sets a boolean indicating if alpha must be an inherited value (false by default)
- */
- static AllowAlphaInheritance: boolean;
- private _alpha;
- private _alphaSet;
- private _zIndex;
- /** @hidden */
- _host: AdvancedDynamicTexture;
- /** Gets or sets the control parent */
- parent: BABYLON.Nullable<Container>;
- /** @hidden */
- _currentMeasure: Measure;
- private _fontFamily;
- private _fontStyle;
- private _fontWeight;
- private _fontSize;
- private _font;
- /** @hidden */
- _width: ValueAndUnit;
- /** @hidden */
- _height: ValueAndUnit;
- /** @hidden */
- protected _fontOffset: {
- ascent: number;
- height: number;
- descent: number;
- };
- private _color;
- private _style;
- private _styleObserver;
- /** @hidden */
- protected _horizontalAlignment: number;
- /** @hidden */
- protected _verticalAlignment: number;
- /** @hidden */
- protected _isDirty: boolean;
- /** @hidden */
- protected _wasDirty: boolean;
- /** @hidden */
- _tempParentMeasure: Measure;
- /** @hidden */
- _prevCurrentMeasureTransformedIntoGlobalSpace: Measure;
- /** @hidden */
- protected _cachedParentMeasure: Measure;
- private _paddingLeft;
- private _paddingRight;
- private _paddingTop;
- private _paddingBottom;
- /** @hidden */
- _left: ValueAndUnit;
- /** @hidden */
- _top: ValueAndUnit;
- private _scaleX;
- private _scaleY;
- private _rotation;
- private _transformCenterX;
- private _transformCenterY;
- /** @hidden */
- _transformMatrix: Matrix2D;
- /** @hidden */
- protected _invertTransformMatrix: Matrix2D;
- /** @hidden */
- protected _transformedPosition: BABYLON.Vector2;
- private _isMatrixDirty;
- private _cachedOffsetX;
- private _cachedOffsetY;
- private _isVisible;
- private _isHighlighted;
- /** @hidden */
- _linkedMesh: BABYLON.Nullable<BABYLON.AbstractMesh>;
- private _fontSet;
- private _dummyVector2;
- private _downCount;
- private _enterCount;
- private _doNotRender;
- private _downPointerIds;
- protected _isEnabled: boolean;
- protected _disabledColor: string;
- protected _disabledColorItem: string;
- /** @hidden */
- protected _rebuildLayout: boolean;
- /** @hidden */
- _customData: any;
- /** @hidden */
- _isClipped: boolean;
- /** @hidden */
- _automaticSize: boolean;
- /** @hidden */
- _tag: any;
- /**
- * 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
- */
- uniqueId: number;
- /**
- * Gets or sets an object used to store user defined information for the node
- */
- metadata: any;
- /** Gets or sets a boolean indicating if the control can be hit with pointer events */
- isHitTestVisible: boolean;
- /** Gets or sets a boolean indicating if the control can block pointer events */
- isPointerBlocker: boolean;
- /** Gets or sets a boolean indicating if the control can be focusable */
- isFocusInvisible: boolean;
- /**
- * Gets or sets a boolean indicating if the children are clipped to the current control bounds.
- * 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
- */
- clipChildren: boolean;
- /**
- * Gets or sets a boolean indicating that control content must be clipped
- * 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
- */
- clipContent: boolean;
- /**
- * Gets or sets a boolean indicating that the current control should cache its rendering (useful when the control does not change often)
- */
- useBitmapCache: boolean;
- private _cacheData;
- private _shadowOffsetX;
- /** Gets or sets a value indicating the offset to apply on X axis to render the shadow */
- get shadowOffsetX(): number;
- set shadowOffsetX(value: number);
- private _shadowOffsetY;
- /** Gets or sets a value indicating the offset to apply on Y axis to render the shadow */
- get shadowOffsetY(): number;
- set shadowOffsetY(value: number);
- private _shadowBlur;
- /** Gets or sets a value indicating the amount of blur to use to render the shadow */
- get shadowBlur(): number;
- set shadowBlur(value: number);
- private _shadowColor;
- /** Gets or sets a value indicating the color of the shadow (black by default ie. "#000") */
- get shadowColor(): string;
- set shadowColor(value: string);
- /** Gets or sets the cursor to use when the control is hovered */
- hoverCursor: string;
- /** @hidden */
- protected _linkOffsetX: ValueAndUnit;
- /** @hidden */
- protected _linkOffsetY: ValueAndUnit;
- /** Gets the control type name */
- get typeName(): string;
- /**
- * Get the current class name of the control.
- * @returns current class name
- */
- getClassName(): string;
- /**
- * An event triggered when pointer wheel is scrolled
- */
- onWheelObservable: BABYLON.Observable<BABYLON.Vector2>;
- /**
- * An event triggered when the pointer move over the control.
- */
- onPointerMoveObservable: BABYLON.Observable<BABYLON.Vector2>;
- /**
- * An event triggered when the pointer move out of the control.
- */
- onPointerOutObservable: BABYLON.Observable<Control>;
- /**
- * An event triggered when the pointer taps the control
- */
- onPointerDownObservable: BABYLON.Observable<Vector2WithInfo>;
- /**
- * An event triggered when pointer up
- */
- onPointerUpObservable: BABYLON.Observable<Vector2WithInfo>;
- /**
- * An event triggered when a control is clicked on
- */
- onPointerClickObservable: BABYLON.Observable<Vector2WithInfo>;
- /**
- * An event triggered when pointer enters the control
- */
- onPointerEnterObservable: BABYLON.Observable<Control>;
- /**
- * An event triggered when the control is marked as dirty
- */
- onDirtyObservable: BABYLON.Observable<Control>;
- /**
- * An event triggered before drawing the control
- */
- onBeforeDrawObservable: BABYLON.Observable<Control>;
- /**
- * An event triggered after the control was drawn
- */
- onAfterDrawObservable: BABYLON.Observable<Control>;
- /**
- * An event triggered when the control has been disposed
- */
- onDisposeObservable: BABYLON.Observable<Control>;
- /**
- * Get the hosting AdvancedDynamicTexture
- */
- get host(): AdvancedDynamicTexture;
- /** Gets or set information about font offsets (used to render and align text) */
- get fontOffset(): {
- ascent: number;
- height: number;
- descent: number;
- };
- set fontOffset(offset: {
- ascent: number;
- height: number;
- descent: number;
- });
- /** Gets or sets alpha value for the control (1 means opaque and 0 means entirely transparent) */
- get alpha(): number;
- set alpha(value: number);
- /**
- * Gets or sets a boolean indicating that we want to highlight the control (mostly for debugging purpose)
- */
- get isHighlighted(): boolean;
- set isHighlighted(value: boolean);
- /** Gets or sets a value indicating the scale factor on X axis (1 by default)
- * @see https://doc.babylonjs.com/how_to/gui#rotation-and-scaling
- */
- get scaleX(): number;
- set scaleX(value: number);
- /** Gets or sets a value indicating the scale factor on Y axis (1 by default)
- * @see https://doc.babylonjs.com/how_to/gui#rotation-and-scaling
- */
- get scaleY(): number;
- set scaleY(value: number);
- /** Gets or sets the rotation angle (0 by default)
- * @see https://doc.babylonjs.com/how_to/gui#rotation-and-scaling
- */
- get rotation(): number;
- set rotation(value: number);
- /** Gets or sets the transformation center on Y axis (0 by default)
- * @see https://doc.babylonjs.com/how_to/gui#rotation-and-scaling
- */
- get transformCenterY(): number;
- set transformCenterY(value: number);
- /** Gets or sets the transformation center on X axis (0 by default)
- * @see https://doc.babylonjs.com/how_to/gui#rotation-and-scaling
- */
- get transformCenterX(): number;
- set transformCenterX(value: number);
- /**
- * Gets or sets the horizontal alignment
- * @see https://doc.babylonjs.com/how_to/gui#alignments
- */
- get horizontalAlignment(): number;
- set horizontalAlignment(value: number);
- /**
- * Gets or sets the vertical alignment
- * @see https://doc.babylonjs.com/how_to/gui#alignments
- */
- get verticalAlignment(): number;
- set verticalAlignment(value: number);
- /**
- * Gets or sets a fixed ratio for this control.
- * When different from 0, the ratio is used to compute the "second" dimension.
- * The first dimension used in the computation is the last one set (by setting width / widthInPixels or height / heightInPixels), and the
- * second dimension is computed as first dimension * fixedRatio
- */
- fixedRatio: number;
- private _fixedRatioMasterIsWidth;
- /**
- * Gets or sets control width
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get width(): string | number;
- set width(value: string | number);
- /**
- * Gets or sets the control width in pixel
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get widthInPixels(): number;
- set widthInPixels(value: number);
- /**
- * Gets or sets control height
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get height(): string | number;
- set height(value: string | number);
- /**
- * Gets or sets control height in pixel
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get heightInPixels(): number;
- set heightInPixels(value: number);
- /** Gets or set font family */
- get fontFamily(): string;
- set fontFamily(value: string);
- /** Gets or sets font style */
- get fontStyle(): string;
- set fontStyle(value: string);
- /** Gets or sets font weight */
- get fontWeight(): string;
- set fontWeight(value: string);
- /**
- * Gets or sets style
- * @see https://doc.babylonjs.com/how_to/gui#styles
- */
- get style(): BABYLON.Nullable<Style>;
- set style(value: BABYLON.Nullable<Style>);
- /** @hidden */
- get _isFontSizeInPercentage(): boolean;
- /** Gets or sets font size in pixels */
- get fontSizeInPixels(): number;
- set fontSizeInPixels(value: number);
- /** Gets or sets font size */
- get fontSize(): string | number;
- set fontSize(value: string | number);
- /** Gets or sets foreground color */
- get color(): string;
- set color(value: string);
- /** Gets or sets z index which is used to reorder controls on the z axis */
- get zIndex(): number;
- set zIndex(value: number);
- /** Gets or sets a boolean indicating if the control can be rendered */
- get notRenderable(): boolean;
- set notRenderable(value: boolean);
- /** Gets or sets a boolean indicating if the control is visible */
- get isVisible(): boolean;
- set isVisible(value: boolean);
- /** Gets a boolean indicating that the control needs to update its rendering */
- get isDirty(): boolean;
- /**
- * Gets the current linked mesh (or null if none)
- */
- get linkedMesh(): BABYLON.Nullable<BABYLON.AbstractMesh>;
- /**
- * Gets or sets a value indicating the padding to use on the left of the control
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get paddingLeft(): string | number;
- set paddingLeft(value: string | number);
- /**
- * Gets or sets a value indicating the padding in pixels to use on the left of the control
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get paddingLeftInPixels(): number;
- set paddingLeftInPixels(value: number);
- /**
- * Gets or sets a value indicating the padding to use on the right of the control
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get paddingRight(): string | number;
- set paddingRight(value: string | number);
- /**
- * Gets or sets a value indicating the padding in pixels to use on the right of the control
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get paddingRightInPixels(): number;
- set paddingRightInPixels(value: number);
- /**
- * Gets or sets a value indicating the padding to use on the top of the control
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get paddingTop(): string | number;
- set paddingTop(value: string | number);
- /**
- * Gets or sets a value indicating the padding in pixels to use on the top of the control
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get paddingTopInPixels(): number;
- set paddingTopInPixels(value: number);
- /**
- * Gets or sets a value indicating the padding to use on the bottom of the control
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get paddingBottom(): string | number;
- set paddingBottom(value: string | number);
- /**
- * Gets or sets a value indicating the padding in pixels to use on the bottom of the control
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get paddingBottomInPixels(): number;
- set paddingBottomInPixels(value: number);
- /**
- * Gets or sets a value indicating the left coordinate of the control
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get left(): string | number;
- set left(value: string | number);
- /**
- * Gets or sets a value indicating the left coordinate in pixels of the control
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get leftInPixels(): number;
- set leftInPixels(value: number);
- /**
- * Gets or sets a value indicating the top coordinate of the control
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get top(): string | number;
- set top(value: string | number);
- /**
- * Gets or sets a value indicating the top coordinate in pixels of the control
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get topInPixels(): number;
- set topInPixels(value: number);
- /**
- * Gets or sets a value indicating the offset on X axis to the linked mesh
- * @see https://doc.babylonjs.com/how_to/gui#tracking-positions
- */
- get linkOffsetX(): string | number;
- set linkOffsetX(value: string | number);
- /**
- * Gets or sets a value indicating the offset in pixels on X axis to the linked mesh
- * @see https://doc.babylonjs.com/how_to/gui#tracking-positions
- */
- get linkOffsetXInPixels(): number;
- set linkOffsetXInPixels(value: number);
- /**
- * Gets or sets a value indicating the offset on Y axis to the linked mesh
- * @see https://doc.babylonjs.com/how_to/gui#tracking-positions
- */
- get linkOffsetY(): string | number;
- set linkOffsetY(value: string | number);
- /**
- * Gets or sets a value indicating the offset in pixels on Y axis to the linked mesh
- * @see https://doc.babylonjs.com/how_to/gui#tracking-positions
- */
- get linkOffsetYInPixels(): number;
- set linkOffsetYInPixels(value: number);
- /** Gets the center coordinate on X axis */
- get centerX(): number;
- /** Gets the center coordinate on Y axis */
- get centerY(): number;
- /** Gets or sets if control is Enabled*/
- get isEnabled(): boolean;
- set isEnabled(value: boolean);
- /** Gets or sets background color of control if it's disabled*/
- get disabledColor(): string;
- set disabledColor(value: string);
- /** Gets or sets front color of control if it's disabled*/
- get disabledColorItem(): string;
- set disabledColorItem(value: string);
- /**
- * Creates a new control
- * @param name defines the name of the control
- */
- constructor(
- /** defines the name of the control */
- name?: string | undefined);
- /** @hidden */
- protected _getTypeName(): string;
- /**
- * Gets the first ascendant in the hierarchy of the given type
- * @param className defines the required type
- * @returns the ascendant or null if not found
- */
- getAscendantOfClass(className: string): BABYLON.Nullable<Control>;
- /** @hidden */
- _resetFontCache(): void;
- /**
- * Determines if a container is an ascendant of the current control
- * @param container defines the container to look for
- * @returns true if the container is one of the ascendant of the control
- */
- isAscendant(container: Control): boolean;
- /**
- * Gets coordinates in local control space
- * @param globalCoordinates defines the coordinates to transform
- * @returns the new coordinates in local space
- */
- getLocalCoordinates(globalCoordinates: BABYLON.Vector2): BABYLON.Vector2;
- /**
- * Gets coordinates in local control space
- * @param globalCoordinates defines the coordinates to transform
- * @param result defines the target vector2 where to store the result
- * @returns the current control
- */
- getLocalCoordinatesToRef(globalCoordinates: BABYLON.Vector2, result: BABYLON.Vector2): Control;
- /**
- * Gets coordinates in parent local control space
- * @param globalCoordinates defines the coordinates to transform
- * @returns the new coordinates in parent local space
- */
- getParentLocalCoordinates(globalCoordinates: BABYLON.Vector2): BABYLON.Vector2;
- /**
- * Move the current control to a vector3 position projected onto the screen.
- * @param position defines the target position
- * @param scene defines the hosting scene
- */
- moveToVector3(position: BABYLON.Vector3, scene: BABYLON.Scene): void;
- /**
- * Will store all controls that have this control as ascendant in a given array
- * @param results defines the array where to store the descendants
- * @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
- * @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
- */
- getDescendantsToRef(results: Control[], directDescendantsOnly?: boolean, predicate?: (control: Control) => boolean): void;
- /**
- * Will return all controls that have this control as ascendant
- * @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
- * @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
- * @return all child controls
- */
- getDescendants(directDescendantsOnly?: boolean, predicate?: (control: Control) => boolean): Control[];
- /**
- * Link current control with a target mesh
- * @param mesh defines the mesh to link with
- * @see https://doc.babylonjs.com/how_to/gui#tracking-positions
- */
- linkWithMesh(mesh: BABYLON.Nullable<BABYLON.AbstractMesh>): void;
- /** @hidden */
- _moveToProjectedPosition(projectedPosition: BABYLON.Vector3): void;
- /** @hidden */
- _offsetLeft(offset: number): void;
- /** @hidden */
- _offsetTop(offset: number): void;
- /** @hidden */
- _markMatrixAsDirty(): void;
- /** @hidden */
- _flagDescendantsAsMatrixDirty(): void;
- /** @hidden */
- _intersectsRect(rect: Measure): boolean;
- /** @hidden */
- protected invalidateRect(): void;
- /** @hidden */
- _markAsDirty(force?: boolean): void;
- /** @hidden */
- _markAllAsDirty(): void;
- /** @hidden */
- _link(host: AdvancedDynamicTexture): void;
- /** @hidden */
- protected _transform(context?: CanvasRenderingContext2D): void;
- /** @hidden */
- _renderHighlight(context: CanvasRenderingContext2D): void;
- /** @hidden */
- _renderHighlightSpecific(context: CanvasRenderingContext2D): void;
- /** @hidden */
- protected _applyStates(context: CanvasRenderingContext2D): void;
- /** @hidden */
- _layout(parentMeasure: Measure, context: CanvasRenderingContext2D): boolean;
- /** @hidden */
- protected _processMeasures(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- protected _evaluateClippingState(parentMeasure: Measure): void;
- /** @hidden */
- _measure(): void;
- /** @hidden */
- protected _computeAlignment(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- /** @hidden */
- protected _preMeasure(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- /** @hidden */
- protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- /** @hidden */
- protected _clipForChildren(context: CanvasRenderingContext2D): void;
- private static _ClipMeasure;
- private _tmpMeasureA;
- private _clip;
- /** @hidden */
- _render(context: CanvasRenderingContext2D, invalidatedRectangle?: BABYLON.Nullable<Measure>): boolean;
- /** @hidden */
- _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: BABYLON.Nullable<Measure>): void;
- /**
- * Tests if a given coordinates belong to the current control
- * @param x defines x coordinate to test
- * @param y defines y coordinate to test
- * @returns true if the coordinates are inside the control
- */
- contains(x: number, y: number): boolean;
- /** @hidden */
- _processPicking(x: number, y: number, type: number, pointerId: number, buttonIndex: number, deltaX?: number, deltaY?: number): boolean;
- /** @hidden */
- _onPointerMove(target: Control, coordinates: BABYLON.Vector2, pointerId: number): void;
- /** @hidden */
- _onPointerEnter(target: Control): boolean;
- /** @hidden */
- _onPointerOut(target: Control, force?: boolean): void;
- /** @hidden */
- _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number): boolean;
- /** @hidden */
- _onPointerUp(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean): void;
- /** @hidden */
- _forcePointerUp(pointerId?: BABYLON.Nullable<number>): void;
- /** @hidden */
- _onWheelScroll(deltaX?: number, deltaY?: number): void;
- /** @hidden */
- _onCanvasBlur(): void;
- /** @hidden */
- _processObservables(type: number, x: number, y: number, pointerId: number, buttonIndex: number, deltaX?: number, deltaY?: number): boolean;
- private _prepareFont;
- /** Releases associated resources */
- dispose(): void;
- private static _HORIZONTAL_ALIGNMENT_LEFT;
- private static _HORIZONTAL_ALIGNMENT_RIGHT;
- private static _HORIZONTAL_ALIGNMENT_CENTER;
- private static _VERTICAL_ALIGNMENT_TOP;
- private static _VERTICAL_ALIGNMENT_BOTTOM;
- private static _VERTICAL_ALIGNMENT_CENTER;
- /** HORIZONTAL_ALIGNMENT_LEFT */
- static get HORIZONTAL_ALIGNMENT_LEFT(): number;
- /** HORIZONTAL_ALIGNMENT_RIGHT */
- static get HORIZONTAL_ALIGNMENT_RIGHT(): number;
- /** HORIZONTAL_ALIGNMENT_CENTER */
- static get HORIZONTAL_ALIGNMENT_CENTER(): number;
- /** VERTICAL_ALIGNMENT_TOP */
- static get VERTICAL_ALIGNMENT_TOP(): number;
- /** VERTICAL_ALIGNMENT_BOTTOM */
- static get VERTICAL_ALIGNMENT_BOTTOM(): number;
- /** VERTICAL_ALIGNMENT_CENTER */
- static get VERTICAL_ALIGNMENT_CENTER(): number;
- private static _FontHeightSizes;
- /** @hidden */
- static _GetFontOffset(font: string): {
- ascent: number;
- height: number;
- descent: number;
- };
- /**
- * Creates a stack panel that can be used to render headers
- * @param control defines the control to associate with the header
- * @param text defines the text of the header
- * @param size defines the size of the header
- * @param options defines options used to configure the header
- * @returns a new StackPanel
- * @ignore
- * @hidden
- */
- static AddHeader: (control: Control, text: string, size: string | number, options: {
- isHorizontal: boolean;
- controlFirst: boolean;
- }) => any;
- /** @hidden */
- protected static drawEllipse(x: number, y: number, width: number, height: number, context: CanvasRenderingContext2D): void;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Root class for 2D containers
- * @see https://doc.babylonjs.com/how_to/gui#containers
- */
- export class Container extends Control {
- name?: string | undefined;
- /** @hidden */
- _children: Control[];
- /** @hidden */
- protected _measureForChildren: Measure;
- /** @hidden */
- protected _background: string;
- /** @hidden */
- protected _adaptWidthToChildren: boolean;
- /** @hidden */
- protected _adaptHeightToChildren: boolean;
- /**
- * Gets or sets a boolean indicating that layout cycle errors should be displayed on the console
- */
- logLayoutCycleErrors: boolean;
- /**
- * Gets or sets the number of layout cycles (a change involved by a control while evaluating the layout) allowed
- */
- maxLayoutCycle: number;
- /** Gets or sets a boolean indicating if the container should try to adapt to its children height */
- get adaptHeightToChildren(): boolean;
- set adaptHeightToChildren(value: boolean);
- /** Gets or sets a boolean indicating if the container should try to adapt to its children width */
- get adaptWidthToChildren(): boolean;
- set adaptWidthToChildren(value: boolean);
- /** Gets or sets background color */
- get background(): string;
- set background(value: string);
- /** Gets the list of children */
- get children(): Control[];
- /**
- * Creates a new Container
- * @param name defines the name of the container
- */
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- _flagDescendantsAsMatrixDirty(): void;
- /**
- * Gets a child using its name
- * @param name defines the child name to look for
- * @returns the child control if found
- */
- getChildByName(name: string): BABYLON.Nullable<Control>;
- /**
- * Gets a child using its type and its name
- * @param name defines the child name to look for
- * @param type defines the child type to look for
- * @returns the child control if found
- */
- getChildByType(name: string, type: string): BABYLON.Nullable<Control>;
- /**
- * Search for a specific control in children
- * @param control defines the control to look for
- * @returns true if the control is in child list
- */
- containsControl(control: Control): boolean;
- /**
- * Adds a new control to the current container
- * @param control defines the control to add
- * @returns the current container
- */
- addControl(control: BABYLON.Nullable<Control>): Container;
- /**
- * Removes all controls from the current container
- * @returns the current container
- */
- clearControls(): Container;
- /**
- * Removes a control from the current container
- * @param control defines the control to remove
- * @returns the current container
- */
- removeControl(control: Control): Container;
- /** @hidden */
- _reOrderControl(control: Control): void;
- /** @hidden */
- _offsetLeft(offset: number): void;
- /** @hidden */
- _offsetTop(offset: number): void;
- /** @hidden */
- _markAllAsDirty(): void;
- /** @hidden */
- protected _localDraw(context: CanvasRenderingContext2D): void;
- /** @hidden */
- _link(host: AdvancedDynamicTexture): void;
- /** @hidden */
- protected _beforeLayout(): void;
- /** @hidden */
- protected _processMeasures(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- /** @hidden */
- _layout(parentMeasure: Measure, context: CanvasRenderingContext2D): boolean;
- protected _postMeasure(): void;
- /** @hidden */
- _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: Measure): void;
- getDescendantsToRef(results: Control[], directDescendantsOnly?: boolean, predicate?: (control: Control) => boolean): void;
- /** @hidden */
- _processPicking(x: number, y: number, type: number, pointerId: number, buttonIndex: number, deltaX?: number, deltaY?: number): boolean;
- /** @hidden */
- protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- /** Releases associated resources */
- dispose(): void;
- }
- }
- declare module BABYLON.GUI {
- /** Class used to create rectangle container */
- export class Rectangle extends Container {
- name?: string | undefined;
- private _thickness;
- private _cornerRadius;
- /** Gets or sets border thickness */
- get thickness(): number;
- set thickness(value: number);
- /** Gets or sets the corner radius angle */
- get cornerRadius(): number;
- set cornerRadius(value: number);
- /**
- * Creates a new Rectangle
- * @param name defines the control name
- */
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- protected _localDraw(context: CanvasRenderingContext2D): void;
- protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- private _drawRoundedRect;
- protected _clipForChildren(context: CanvasRenderingContext2D): void;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Enum that determines the text-wrapping mode to use.
- */
- export enum TextWrapping {
- /**
- * Clip the text when it's larger than Control.width; this is the default mode.
- */
- Clip = 0,
- /**
- * Wrap the text word-wise, i.e. try to add line-breaks at word boundary to fit within Control.width.
- */
- WordWrap = 1,
- /**
- * Ellipsize the text, i.e. shrink with trailing … when text is larger than Control.width.
- */
- Ellipsis = 2
- }
- /**
- * Class used to create text block control
- */
- export class TextBlock extends Control {
- /**
- * Defines the name of the control
- */
- name?: string | undefined;
- private _text;
- private _textWrapping;
- private _textHorizontalAlignment;
- private _textVerticalAlignment;
- private _lines;
- private _resizeToFit;
- private _lineSpacing;
- private _outlineWidth;
- private _outlineColor;
- private _underline;
- private _lineThrough;
- /**
- * An event triggered after the text is changed
- */
- onTextChangedObservable: BABYLON.Observable<TextBlock>;
- /**
- * An event triggered after the text was broken up into lines
- */
- onLinesReadyObservable: BABYLON.Observable<TextBlock>;
- /**
- * Function used to split a string into words. By default, a string is split at each space character found
- */
- wordSplittingFunction: BABYLON.Nullable<(line: string) => string[]>;
- /**
- * Return the line list (you may need to use the onLinesReadyObservable to make sure the list is ready)
- */
- get lines(): any[];
- /**
- * Gets or sets an boolean indicating that the TextBlock will be resized to fit container
- */
- get resizeToFit(): boolean;
- /**
- * Gets or sets an boolean indicating that the TextBlock will be resized to fit container
- */
- set resizeToFit(value: boolean);
- /**
- * Gets or sets a boolean indicating if text must be wrapped
- */
- get textWrapping(): TextWrapping | boolean;
- /**
- * Gets or sets a boolean indicating if text must be wrapped
- */
- set textWrapping(value: TextWrapping | boolean);
- /**
- * Gets or sets text to display
- */
- get text(): string;
- /**
- * Gets or sets text to display
- */
- set text(value: string);
- /**
- * Gets or sets text horizontal alignment (BABYLON.GUI.Control.HORIZONTAL_ALIGNMENT_CENTER by default)
- */
- get textHorizontalAlignment(): number;
- /**
- * Gets or sets text horizontal alignment (BABYLON.GUI.Control.HORIZONTAL_ALIGNMENT_CENTER by default)
- */
- set textHorizontalAlignment(value: number);
- /**
- * Gets or sets text vertical alignment (BABYLON.GUI.Control.VERTICAL_ALIGNMENT_CENTER by default)
- */
- get textVerticalAlignment(): number;
- /**
- * Gets or sets text vertical alignment (BABYLON.GUI.Control.VERTICAL_ALIGNMENT_CENTER by default)
- */
- set textVerticalAlignment(value: number);
- /**
- * Gets or sets line spacing value
- */
- set lineSpacing(value: string | number);
- /**
- * Gets or sets line spacing value
- */
- get lineSpacing(): string | number;
- /**
- * Gets or sets outlineWidth of the text to display
- */
- get outlineWidth(): number;
- /**
- * Gets or sets outlineWidth of the text to display
- */
- set outlineWidth(value: number);
- /**
- * Gets or sets a boolean indicating that text must have underline
- */
- get underline(): boolean;
- /**
- * Gets or sets a boolean indicating that text must have underline
- */
- set underline(value: boolean);
- /**
- * Gets or sets an boolean indicating that text must be crossed out
- */
- get lineThrough(): boolean;
- /**
- * Gets or sets an boolean indicating that text must be crossed out
- */
- set lineThrough(value: boolean);
- /**
- * Gets or sets outlineColor of the text to display
- */
- get outlineColor(): string;
- /**
- * Gets or sets outlineColor of the text to display
- */
- set outlineColor(value: string);
- /**
- * Creates a new TextBlock object
- * @param name defines the name of the control
- * @param text defines the text to display (emptry string by default)
- */
- constructor(
- /**
- * Defines the name of the control
- */
- name?: string | undefined, text?: string);
- protected _getTypeName(): string;
- protected _processMeasures(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- private _drawText;
- /** @hidden */
- _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: BABYLON.Nullable<Measure>): void;
- protected _applyStates(context: CanvasRenderingContext2D): void;
- protected _breakLines(refWidth: number, context: CanvasRenderingContext2D): object[];
- protected _parseLine(line: string | undefined, context: CanvasRenderingContext2D): object;
- protected _parseLineEllipsis(line: string | undefined, width: number, context: CanvasRenderingContext2D): object;
- protected _parseLineWordWrap(line: string | undefined, width: number, context: CanvasRenderingContext2D): object[];
- protected _renderLines(context: CanvasRenderingContext2D): void;
- /**
- * Given a width constraint applied on the text block, find the expected height
- * @returns expected height
- */
- computeExpectedHeight(): number;
- dispose(): void;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to create 2D images
- */
- export class Image extends Control {
- name?: string | undefined;
- private _workingCanvas;
- private _domImage;
- private _imageWidth;
- private _imageHeight;
- private _loaded;
- private _stretch;
- private _source;
- private _autoScale;
- private _sourceLeft;
- private _sourceTop;
- private _sourceWidth;
- private _sourceHeight;
- private _svgAttributesComputationCompleted;
- private _isSVG;
- private _cellWidth;
- private _cellHeight;
- private _cellId;
- private _populateNinePatchSlicesFromImage;
- private _sliceLeft;
- private _sliceRight;
- private _sliceTop;
- private _sliceBottom;
- private _detectPointerOnOpaqueOnly;
- private _imageDataCache;
- /**
- * BABYLON.Observable notified when the content is loaded
- */
- onImageLoadedObservable: BABYLON.Observable<Image>;
- /**
- * BABYLON.Observable notified when _sourceLeft, _sourceTop, _sourceWidth and _sourceHeight are computed
- */
- onSVGAttributesComputedObservable: BABYLON.Observable<Image>;
- /**
- * Gets a boolean indicating that the content is loaded
- */
- get isLoaded(): boolean;
- /**
- * Gets or sets a boolean indicating if nine patch slices (left, top, right, bottom) should be read from image data
- */
- get populateNinePatchSlicesFromImage(): boolean;
- set populateNinePatchSlicesFromImage(value: boolean);
- /**
- * Gets or sets a boolean indicating if pointers should only be validated on pixels with alpha > 0.
- * Beware using this as this will comsume more memory as the image has to be stored twice
- */
- get detectPointerOnOpaqueOnly(): boolean;
- set detectPointerOnOpaqueOnly(value: boolean);
- /**
- * Gets or sets the left value for slicing (9-patch)
- */
- get sliceLeft(): number;
- set sliceLeft(value: number);
- /**
- * Gets or sets the right value for slicing (9-patch)
- */
- get sliceRight(): number;
- set sliceRight(value: number);
- /**
- * Gets or sets the top value for slicing (9-patch)
- */
- get sliceTop(): number;
- set sliceTop(value: number);
- /**
- * Gets or sets the bottom value for slicing (9-patch)
- */
- get sliceBottom(): number;
- set sliceBottom(value: number);
- /**
- * Gets or sets the left coordinate in the source image
- */
- get sourceLeft(): number;
- set sourceLeft(value: number);
- /**
- * Gets or sets the top coordinate in the source image
- */
- get sourceTop(): number;
- set sourceTop(value: number);
- /**
- * Gets or sets the width to capture in the source image
- */
- get sourceWidth(): number;
- set sourceWidth(value: number);
- /**
- * Gets or sets the height to capture in the source image
- */
- get sourceHeight(): number;
- set sourceHeight(value: number);
- /** Indicates if the format of the image is SVG */
- get isSVG(): boolean;
- /** Gets the status of the SVG attributes computation (sourceLeft, sourceTop, sourceWidth, sourceHeight) */
- get svgAttributesComputationCompleted(): boolean;
- /**
- * Gets or sets a boolean indicating if the image can force its container to adapt its size
- * @see https://doc.babylonjs.com/how_to/gui#image
- */
- get autoScale(): boolean;
- set autoScale(value: boolean);
- /** Gets or sets the streching mode used by the image */
- get stretch(): number;
- set stretch(value: number);
- /** @hidden */
- _rotate90(n: number, preserveProperties?: boolean): Image;
- private _handleRotationForSVGImage;
- private _rotate90SourceProperties;
- /**
- * Gets or sets the internal DOM image used to render the control
- */
- set domImage(value: HTMLImageElement);
- get domImage(): HTMLImageElement;
- private _onImageLoaded;
- private _extractNinePatchSliceDataFromImage;
- /**
- * Gets or sets image source url
- */
- set source(value: BABYLON.Nullable<string>);
- /**
- * Checks for svg document with icon id present
- */
- private _svgCheck;
- /**
- * Sets sourceLeft, sourceTop, sourceWidth, sourceHeight automatically
- * given external svg file and icon id
- */
- private _getSVGAttribs;
- /**
- * Gets or sets the cell width to use when animation sheet is enabled
- * @see https://doc.babylonjs.com/how_to/gui#image
- */
- get cellWidth(): number;
- set cellWidth(value: number);
- /**
- * Gets or sets the cell height to use when animation sheet is enabled
- * @see https://doc.babylonjs.com/how_to/gui#image
- */
- get cellHeight(): number;
- set cellHeight(value: number);
- /**
- * Gets or sets the cell id to use (this will turn on the animation sheet mode)
- * @see https://doc.babylonjs.com/how_to/gui#image
- */
- get cellId(): number;
- set cellId(value: number);
- /**
- * Creates a new Image
- * @param name defines the control name
- * @param url defines the image url
- */
- constructor(name?: string | undefined, url?: BABYLON.Nullable<string>);
- /**
- * Tests if a given coordinates belong to the current control
- * @param x defines x coordinate to test
- * @param y defines y coordinate to test
- * @returns true if the coordinates are inside the control
- */
- contains(x: number, y: number): boolean;
- protected _getTypeName(): string;
- /** Force the control to synchronize with its content */
- synchronizeSizeWithContent(): void;
- protected _processMeasures(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- private _prepareWorkingCanvasForOpaqueDetection;
- private _drawImage;
- _draw(context: CanvasRenderingContext2D): void;
- private _renderCornerPatch;
- private _renderNinePatch;
- dispose(): void;
- /** STRETCH_NONE */
- static readonly STRETCH_NONE: number;
- /** STRETCH_FILL */
- static readonly STRETCH_FILL: number;
- /** STRETCH_UNIFORM */
- static readonly STRETCH_UNIFORM: number;
- /** STRETCH_EXTEND */
- static readonly STRETCH_EXTEND: number;
- /** NINE_PATCH */
- static readonly STRETCH_NINE_PATCH: number;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to create 2D buttons
- */
- export class Button extends Rectangle {
- name?: string | undefined;
- /**
- * Function called to generate a pointer enter animation
- */
- pointerEnterAnimation: () => void;
- /**
- * Function called to generate a pointer out animation
- */
- pointerOutAnimation: () => void;
- /**
- * Function called to generate a pointer down animation
- */
- pointerDownAnimation: () => void;
- /**
- * Function called to generate a pointer up animation
- */
- pointerUpAnimation: () => void;
- /**
- * Gets or sets a boolean indicating that the button will let internal controls handle picking instead of doing it directly using its bounding info
- */
- delegatePickingToChildren: boolean;
- private _image;
- /**
- * Returns the image part of the button (if any)
- */
- get image(): BABYLON.Nullable<Image>;
- private _textBlock;
- /**
- * Returns the image part of the button (if any)
- */
- get textBlock(): BABYLON.Nullable<TextBlock>;
- /**
- * Creates a new Button
- * @param name defines the name of the button
- */
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- /** @hidden */
- _processPicking(x: number, y: number, type: number, pointerId: number, buttonIndex: number, deltaX?: number, deltaY?: number): boolean;
- /** @hidden */
- _onPointerEnter(target: Control): boolean;
- /** @hidden */
- _onPointerOut(target: Control, force?: boolean): void;
- /** @hidden */
- _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number): boolean;
- /** @hidden */
- _onPointerUp(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean): void;
- /**
- * Creates a new button made with an image and a text
- * @param name defines the name of the button
- * @param text defines the text of the button
- * @param imageUrl defines the url of the image
- * @returns a new Button
- */
- static CreateImageButton(name: string, text: string, imageUrl: string): Button;
- /**
- * Creates a new button made with an image
- * @param name defines the name of the button
- * @param imageUrl defines the url of the image
- * @returns a new Button
- */
- static CreateImageOnlyButton(name: string, imageUrl: string): Button;
- /**
- * Creates a new button made with a text
- * @param name defines the name of the button
- * @param text defines the text of the button
- * @returns a new Button
- */
- static CreateSimpleButton(name: string, text: string): Button;
- /**
- * Creates a new button made with an image and a centered text
- * @param name defines the name of the button
- * @param text defines the text of the button
- * @param imageUrl defines the url of the image
- * @returns a new Button
- */
- static CreateImageWithCenterTextButton(name: string, text: string, imageUrl: string): Button;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to create a 2D stack panel container
- */
- export class StackPanel extends Container {
- name?: string | undefined;
- private _isVertical;
- private _manualWidth;
- private _manualHeight;
- private _doNotTrackManualChanges;
- /**
- * Gets or sets a boolean indicating that layou warnings should be ignored
- */
- ignoreLayoutWarnings: boolean;
- /** Gets or sets a boolean indicating if the stack panel is vertical or horizontal*/
- get isVertical(): boolean;
- set isVertical(value: boolean);
- /**
- * Gets or sets panel width.
- * This value should not be set when in horizontal mode as it will be computed automatically
- */
- set width(value: string | number);
- get width(): string | number;
- /**
- * Gets or sets panel height.
- * This value should not be set when in vertical mode as it will be computed automatically
- */
- set height(value: string | number);
- get height(): string | number;
- /**
- * Creates a new StackPanel
- * @param name defines control name
- */
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- /** @hidden */
- protected _preMeasure(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- protected _postMeasure(): void;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to represent a 2D checkbox
- */
- export class Checkbox extends Control {
- name?: string | undefined;
- private _isChecked;
- private _background;
- private _checkSizeRatio;
- private _thickness;
- /** Gets or sets border thickness */
- get thickness(): number;
- set thickness(value: number);
- /**
- * BABYLON.Observable raised when isChecked property changes
- */
- onIsCheckedChangedObservable: BABYLON.Observable<boolean>;
- /** Gets or sets a value indicating the ratio between overall size and check size */
- get checkSizeRatio(): number;
- set checkSizeRatio(value: number);
- /** Gets or sets background color */
- get background(): string;
- set background(value: string);
- /** Gets or sets a boolean indicating if the checkbox is checked or not */
- get isChecked(): boolean;
- set isChecked(value: boolean);
- /**
- * Creates a new CheckBox
- * @param name defines the control name
- */
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- /** @hidden */
- _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: BABYLON.Nullable<Measure>): void;
- /** @hidden */
- _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number): boolean;
- /**
- * Utility function to easily create a checkbox with a header
- * @param title defines the label to use for the header
- * @param onValueChanged defines the callback to call when value changes
- * @returns a StackPanel containing the checkbox and a textBlock
- */
- static AddCheckBoxWithHeader(title: string, onValueChanged: (value: boolean) => void): StackPanel;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to store key control properties
- */
- export class KeyPropertySet {
- /** Width */
- width?: string;
- /** Height */
- height?: string;
- /** Left padding */
- paddingLeft?: string;
- /** Right padding */
- paddingRight?: string;
- /** Top padding */
- paddingTop?: string;
- /** Bottom padding */
- paddingBottom?: string;
- /** Foreground color */
- color?: string;
- /** Background color */
- background?: string;
- }
- /**
- * Class used to create virtual keyboard
- */
- export class VirtualKeyboard extends StackPanel {
- /** BABYLON.Observable raised when a key is pressed */
- onKeyPressObservable: BABYLON.Observable<string>;
- /** Gets or sets default key button width */
- defaultButtonWidth: string;
- /** Gets or sets default key button height */
- defaultButtonHeight: string;
- /** Gets or sets default key button left padding */
- defaultButtonPaddingLeft: string;
- /** Gets or sets default key button right padding */
- defaultButtonPaddingRight: string;
- /** Gets or sets default key button top padding */
- defaultButtonPaddingTop: string;
- /** Gets or sets default key button bottom padding */
- defaultButtonPaddingBottom: string;
- /** Gets or sets default key button foreground color */
- defaultButtonColor: string;
- /** Gets or sets default key button background color */
- defaultButtonBackground: string;
- /** Gets or sets shift button foreground color */
- shiftButtonColor: string;
- /** Gets or sets shift button thickness*/
- selectedShiftThickness: number;
- /** Gets shift key state */
- shiftState: number;
- protected _getTypeName(): string;
- private _createKey;
- /**
- * Adds a new row of keys
- * @param keys defines the list of keys to add
- * @param propertySets defines the associated property sets
- */
- addKeysRow(keys: Array<string>, propertySets?: Array<KeyPropertySet>): void;
- /**
- * Set the shift key to a specific state
- * @param shiftState defines the new shift state
- */
- applyShiftState(shiftState: number): void;
- private _currentlyConnectedInputText;
- private _connectedInputTexts;
- private _onKeyPressObserver;
- /** Gets the input text control currently attached to the keyboard */
- get connectedInputText(): BABYLON.Nullable<InputText>;
- /**
- * Connects the keyboard with an input text control
- *
- * @param input defines the target control
- */
- connect(input: InputText): void;
- /**
- * Disconnects the keyboard from connected InputText controls
- *
- * @param input optionally defines a target control, otherwise all are disconnected
- */
- disconnect(input?: InputText): void;
- private _removeConnectedInputObservables;
- /**
- * Release all resources
- */
- dispose(): void;
- /**
- * Creates a new keyboard using a default layout
- *
- * @param name defines control name
- * @returns a new VirtualKeyboard
- */
- static CreateDefaultLayout(name?: string): VirtualKeyboard;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to create input text control
- */
- export class InputText extends Control implements IFocusableControl {
- name?: string | undefined;
- private _text;
- private _placeholderText;
- private _background;
- private _focusedBackground;
- private _focusedColor;
- private _placeholderColor;
- private _thickness;
- private _margin;
- private _autoStretchWidth;
- private _maxWidth;
- private _isFocused;
- private _blinkTimeout;
- private _blinkIsEven;
- private _cursorOffset;
- private _scrollLeft;
- private _textWidth;
- private _clickedCoordinate;
- private _deadKey;
- private _addKey;
- private _currentKey;
- private _isTextHighlightOn;
- private _textHighlightColor;
- private _highligherOpacity;
- private _highlightedText;
- private _startHighlightIndex;
- private _endHighlightIndex;
- private _cursorIndex;
- private _onFocusSelectAll;
- private _isPointerDown;
- private _onClipboardObserver;
- private _onPointerDblTapObserver;
- /** @hidden */
- _connectedVirtualKeyboard: BABYLON.Nullable<VirtualKeyboard>;
- /** Gets or sets a string representing the message displayed on mobile when the control gets the focus */
- promptMessage: string;
- /** Force disable prompt on mobile device */
- disableMobilePrompt: boolean;
- /** BABYLON.Observable raised when the text changes */
- onTextChangedObservable: BABYLON.Observable<InputText>;
- /** BABYLON.Observable raised just before an entered character is to be added */
- onBeforeKeyAddObservable: BABYLON.Observable<InputText>;
- /** BABYLON.Observable raised when the control gets the focus */
- onFocusObservable: BABYLON.Observable<InputText>;
- /** BABYLON.Observable raised when the control loses the focus */
- onBlurObservable: BABYLON.Observable<InputText>;
- /**Observable raised when the text is highlighted */
- onTextHighlightObservable: BABYLON.Observable<InputText>;
- /**Observable raised when copy event is triggered */
- onTextCopyObservable: BABYLON.Observable<InputText>;
- /** BABYLON.Observable raised when cut event is triggered */
- onTextCutObservable: BABYLON.Observable<InputText>;
- /** BABYLON.Observable raised when paste event is triggered */
- onTextPasteObservable: BABYLON.Observable<InputText>;
- /** BABYLON.Observable raised when a key event was processed */
- onKeyboardEventProcessedObservable: BABYLON.Observable<KeyboardEvent>;
- /** Gets or sets the maximum width allowed by the control */
- get maxWidth(): string | number;
- /** Gets the maximum width allowed by the control in pixels */
- get maxWidthInPixels(): number;
- set maxWidth(value: string | number);
- /** Gets or sets the text highlighter transparency; default: 0.4 */
- get highligherOpacity(): number;
- set highligherOpacity(value: number);
- /** Gets or sets a boolean indicating whether to select complete text by default on input focus */
- get onFocusSelectAll(): boolean;
- set onFocusSelectAll(value: boolean);
- /** Gets or sets the text hightlight color */
- get textHighlightColor(): string;
- set textHighlightColor(value: string);
- /** Gets or sets control margin */
- get margin(): string;
- /** Gets control margin in pixels */
- get marginInPixels(): number;
- set margin(value: string);
- /** Gets or sets a boolean indicating if the control can auto stretch its width to adapt to the text */
- get autoStretchWidth(): boolean;
- set autoStretchWidth(value: boolean);
- /** Gets or sets border thickness */
- get thickness(): number;
- set thickness(value: number);
- /** Gets or sets the background color when focused */
- get focusedBackground(): string;
- set focusedBackground(value: string);
- /** Gets or sets the background color when focused */
- get focusedColor(): string;
- set focusedColor(value: string);
- /** Gets or sets the background color */
- get background(): string;
- set background(value: string);
- /** Gets or sets the placeholder color */
- get placeholderColor(): string;
- set placeholderColor(value: string);
- /** Gets or sets the text displayed when the control is empty */
- get placeholderText(): string;
- set placeholderText(value: string);
- /** Gets or sets the dead key flag */
- get deadKey(): boolean;
- set deadKey(flag: boolean);
- /** Gets or sets the highlight text */
- get highlightedText(): string;
- set highlightedText(text: string);
- /** Gets or sets if the current key should be added */
- get addKey(): boolean;
- set addKey(flag: boolean);
- /** Gets or sets the value of the current key being entered */
- get currentKey(): string;
- set currentKey(key: string);
- /** Gets or sets the text displayed in the control */
- get text(): string;
- set text(value: string);
- /** Gets or sets control width */
- get width(): string | number;
- set width(value: string | number);
- /**
- * Creates a new InputText
- * @param name defines the control name
- * @param text defines the text of the control
- */
- constructor(name?: string | undefined, text?: string);
- /** @hidden */
- onBlur(): void;
- /** @hidden */
- onFocus(): void;
- protected _getTypeName(): string;
- /**
- * Function called to get the list of controls that should not steal the focus from this control
- * @returns an array of controls
- */
- keepsFocusWith(): BABYLON.Nullable<Control[]>;
- /** @hidden */
- processKey(keyCode: number, key?: string, evt?: KeyboardEvent): void;
- /** @hidden */
- private _updateValueFromCursorIndex;
- /** @hidden */
- private _processDblClick;
- /** @hidden */
- private _selectAllText;
- /**
- * Handles the keyboard event
- * @param evt Defines the KeyboardEvent
- */
- processKeyboard(evt: KeyboardEvent): void;
- /** @hidden */
- private _onCopyText;
- /** @hidden */
- private _onCutText;
- /** @hidden */
- private _onPasteText;
- _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: BABYLON.Nullable<Measure>): void;
- _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number): boolean;
- _onPointerMove(target: Control, coordinates: BABYLON.Vector2, pointerId: number): void;
- _onPointerUp(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean): void;
- protected _beforeRenderText(text: string): string;
- dispose(): void;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to create a 2D grid container
- */
- export class Grid extends Container {
- name?: string | undefined;
- private _rowDefinitions;
- private _columnDefinitions;
- private _cells;
- private _childControls;
- /**
- * Gets the number of columns
- */
- get columnCount(): number;
- /**
- * Gets the number of rows
- */
- get rowCount(): number;
- /** Gets the list of children */
- get children(): Control[];
- /** Gets the list of cells (e.g. the containers) */
- get cells(): {
- [key: string]: Container;
- };
- /**
- * Gets the definition of a specific row
- * @param index defines the index of the row
- * @returns the row definition
- */
- getRowDefinition(index: number): BABYLON.Nullable<ValueAndUnit>;
- /**
- * Gets the definition of a specific column
- * @param index defines the index of the column
- * @returns the column definition
- */
- getColumnDefinition(index: number): BABYLON.Nullable<ValueAndUnit>;
- /**
- * Adds a new row to the grid
- * @param height defines the height of the row (either in pixel or a value between 0 and 1)
- * @param isPixel defines if the height is expressed in pixel (or in percentage)
- * @returns the current grid
- */
- addRowDefinition(height: number, isPixel?: boolean): Grid;
- /**
- * Adds a new column to the grid
- * @param width defines the width of the column (either in pixel or a value between 0 and 1)
- * @param isPixel defines if the width is expressed in pixel (or in percentage)
- * @returns the current grid
- */
- addColumnDefinition(width: number, isPixel?: boolean): Grid;
- /**
- * Update a row definition
- * @param index defines the index of the row to update
- * @param height defines the height of the row (either in pixel or a value between 0 and 1)
- * @param isPixel defines if the weight is expressed in pixel (or in percentage)
- * @returns the current grid
- */
- setRowDefinition(index: number, height: number, isPixel?: boolean): Grid;
- /**
- * Update a column definition
- * @param index defines the index of the column to update
- * @param width defines the width of the column (either in pixel or a value between 0 and 1)
- * @param isPixel defines if the width is expressed in pixel (or in percentage)
- * @returns the current grid
- */
- setColumnDefinition(index: number, width: number, isPixel?: boolean): Grid;
- /**
- * Gets the list of children stored in a specific cell
- * @param row defines the row to check
- * @param column defines the column to check
- * @returns the list of controls
- */
- getChildrenAt(row: number, column: number): BABYLON.Nullable<Array<Control>>;
- /**
- * Gets a string representing the child cell info (row x column)
- * @param child defines the control to get info from
- * @returns a string containing the child cell info (row x column)
- */
- getChildCellInfo(child: Control): string;
- private _removeCell;
- private _offsetCell;
- /**
- * Remove a column definition at specified index
- * @param index defines the index of the column to remove
- * @returns the current grid
- */
- removeColumnDefinition(index: number): Grid;
- /**
- * Remove a row definition at specified index
- * @param index defines the index of the row to remove
- * @returns the current grid
- */
- removeRowDefinition(index: number): Grid;
- /**
- * Adds a new control to the current grid
- * @param control defines the control to add
- * @param row defines the row where to add the control (0 by default)
- * @param column defines the column where to add the control (0 by default)
- * @returns the current grid
- */
- addControl(control: Control, row?: number, column?: number): Grid;
- /**
- * Removes a control from the current container
- * @param control defines the control to remove
- * @returns the current container
- */
- removeControl(control: Control): Container;
- /**
- * Creates a new Grid
- * @param name defines control name
- */
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- protected _getGridDefinitions(definitionCallback: (lefts: number[], tops: number[], widths: number[], heights: number[]) => void): void;
- protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- _flagDescendantsAsMatrixDirty(): void;
- _renderHighlightSpecific(context: CanvasRenderingContext2D): void;
- /** Releases associated resources */
- dispose(): void;
- }
- }
- declare module BABYLON.GUI {
- /** Class used to create color pickers */
- export class ColorPicker extends Control {
- name?: string | undefined;
- private static _Epsilon;
- private _colorWheelCanvas;
- private _value;
- private _tmpColor;
- private _pointerStartedOnSquare;
- private _pointerStartedOnWheel;
- private _squareLeft;
- private _squareTop;
- private _squareSize;
- private _h;
- private _s;
- private _v;
- private _lastPointerDownID;
- /**
- * BABYLON.Observable raised when the value changes
- */
- onValueChangedObservable: BABYLON.Observable<BABYLON.Color3>;
- /** Gets or sets the color of the color picker */
- get value(): BABYLON.Color3;
- set value(value: BABYLON.Color3);
- /**
- * Gets or sets control width
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get width(): string | number;
- set width(value: string | number);
- /**
- * Gets or sets control height
- * @see https://doc.babylonjs.com/how_to/gui#position-and-size
- */
- get height(): string | number;
- /** Gets or sets control height */
- set height(value: string | number);
- /** Gets or sets control size */
- get size(): string | number;
- set size(value: string | number);
- /**
- * Creates a new ColorPicker
- * @param name defines the control name
- */
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- /** @hidden */
- protected _preMeasure(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- private _updateSquareProps;
- private _drawGradientSquare;
- private _drawCircle;
- private _createColorWheelCanvas;
- /** @hidden */
- _draw(context: CanvasRenderingContext2D): void;
- private _pointerIsDown;
- private _updateValueFromPointer;
- private _isPointOnSquare;
- private _isPointOnWheel;
- _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number): boolean;
- _onPointerMove(target: Control, coordinates: BABYLON.Vector2, pointerId: number): void;
- _onPointerUp(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean): void;
- _onCanvasBlur(): void;
- /**
- * This function expands the color picker by creating a color picker dialog with manual
- * color value input and the ability to save colors into an array to be used later in
- * subsequent launches of the dialogue.
- * @param advancedTexture defines the AdvancedDynamicTexture the dialog is assigned to
- * @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.
- * @returns picked color as a hex string and the saved colors array as hex strings.
- */
- static ShowPickerDialogAsync(advancedTexture: AdvancedDynamicTexture, options: {
- pickerWidth?: string;
- pickerHeight?: string;
- headerHeight?: string;
- lastColor?: string;
- swatchLimit?: number;
- numSwatchesPerLine?: number;
- savedColors?: Array<string>;
- }): Promise<{
- savedColors?: string[];
- pickedColor: string;
- }>;
- }
- }
- declare module BABYLON.GUI {
- /** Class used to create 2D ellipse containers */
- export class Ellipse extends Container {
- name?: string | undefined;
- private _thickness;
- /** Gets or sets border thickness */
- get thickness(): number;
- set thickness(value: number);
- /**
- * Creates a new Ellipse
- * @param name defines the control name
- */
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- protected _localDraw(context: CanvasRenderingContext2D): void;
- protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- protected _clipForChildren(context: CanvasRenderingContext2D): void;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to create a password control
- */
- export class InputPassword extends InputText {
- protected _beforeRenderText(text: string): string;
- }
- }
- declare module BABYLON.GUI {
- /** Class used to render 2D lines */
- export class Line extends Control {
- name?: string | undefined;
- private _lineWidth;
- private _x1;
- private _y1;
- private _x2;
- private _y2;
- private _dash;
- private _connectedControl;
- private _connectedControlDirtyObserver;
- /** Gets or sets the dash pattern */
- get dash(): Array<number>;
- set dash(value: Array<number>);
- /** Gets or sets the control connected with the line end */
- get connectedControl(): Control;
- set connectedControl(value: Control);
- /** Gets or sets start coordinates on X axis */
- get x1(): string | number;
- set x1(value: string | number);
- /** Gets or sets start coordinates on Y axis */
- get y1(): string | number;
- set y1(value: string | number);
- /** Gets or sets end coordinates on X axis */
- get x2(): string | number;
- set x2(value: string | number);
- /** Gets or sets end coordinates on Y axis */
- get y2(): string | number;
- set y2(value: string | number);
- /** Gets or sets line width */
- get lineWidth(): number;
- set lineWidth(value: number);
- /** Gets or sets horizontal alignment */
- set horizontalAlignment(value: number);
- /** Gets or sets vertical alignment */
- set verticalAlignment(value: number);
- private get _effectiveX2();
- private get _effectiveY2();
- /**
- * Creates a new Line
- * @param name defines the control name
- */
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- _draw(context: CanvasRenderingContext2D): void;
- _measure(): void;
- protected _computeAlignment(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- /**
- * Move one end of the line given 3D cartesian coordinates.
- * @param position Targeted world position
- * @param scene BABYLON.Scene
- * @param end (opt) Set to true to assign x2 and y2 coordinates of the line. Default assign to x1 and y1.
- */
- moveToVector3(position: BABYLON.Vector3, scene: BABYLON.Scene, end?: boolean): void;
- /**
- * Move one end of the line to a position in screen absolute space.
- * @param projectedPosition Position in screen absolute space (X, Y)
- * @param end (opt) Set to true to assign x2 and y2 coordinates of the line. Default assign to x1 and y1.
- */
- _moveToProjectedPosition(projectedPosition: BABYLON.Vector3, end?: boolean): void;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to store a point for a MultiLine object.
- * The point can be pure 2D coordinates, a mesh or a control
- */
- export class MultiLinePoint {
- private _multiLine;
- private _x;
- private _y;
- private _control;
- private _mesh;
- private _controlObserver;
- private _meshObserver;
- /** @hidden */
- _point: BABYLON.Vector2;
- /**
- * Creates a new MultiLinePoint
- * @param multiLine defines the source MultiLine object
- */
- constructor(multiLine: MultiLine);
- /** Gets or sets x coordinate */
- get x(): string | number;
- set x(value: string | number);
- /** Gets or sets y coordinate */
- get y(): string | number;
- set y(value: string | number);
- /** Gets or sets the control associated with this point */
- get control(): BABYLON.Nullable<Control>;
- set control(value: BABYLON.Nullable<Control>);
- /** Gets or sets the mesh associated with this point */
- get mesh(): BABYLON.Nullable<BABYLON.AbstractMesh>;
- set mesh(value: BABYLON.Nullable<BABYLON.AbstractMesh>);
- /** Resets links */
- resetLinks(): void;
- /**
- * Gets a translation vector
- * @returns the translation vector
- */
- translate(): BABYLON.Vector2;
- private _translatePoint;
- /** Release associated resources */
- dispose(): void;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to create multi line control
- */
- export class MultiLine extends Control {
- name?: string | undefined;
- private _lineWidth;
- private _dash;
- private _points;
- private _minX;
- private _minY;
- private _maxX;
- private _maxY;
- /**
- * Creates a new MultiLine
- * @param name defines the control name
- */
- constructor(name?: string | undefined);
- /** Gets or sets dash pattern */
- get dash(): Array<number>;
- set dash(value: Array<number>);
- /**
- * Gets point stored at specified index
- * @param index defines the index to look for
- * @returns the requested point if found
- */
- getAt(index: number): MultiLinePoint;
- /** Function called when a point is updated */
- onPointUpdate: () => void;
- /**
- * Adds new points to the point collection
- * @param items defines the list of items (mesh, control or 2d coordiantes) to add
- * @returns the list of created MultiLinePoint
- */
- add(...items: (AbstractMesh | Control | {
- x: string | number;
- y: string | number;
- })[]): MultiLinePoint[];
- /**
- * Adds a new point to the point collection
- * @param item defines the item (mesh, control or 2d coordiantes) to add
- * @returns the created MultiLinePoint
- */
- push(item?: (AbstractMesh | Control | {
- x: string | number;
- y: string | number;
- })): MultiLinePoint;
- /**
- * Remove a specific value or point from the active point collection
- * @param value defines the value or point to remove
- */
- remove(value: number | MultiLinePoint): void;
- /**
- * Resets this object to initial state (no point)
- */
- reset(): void;
- /**
- * Resets all links
- */
- resetLinks(): void;
- /** Gets or sets line width */
- get lineWidth(): number;
- set lineWidth(value: number);
- set horizontalAlignment(value: number);
- set verticalAlignment(value: number);
- protected _getTypeName(): string;
- _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: BABYLON.Nullable<Measure>): void;
- protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- _measure(): void;
- protected _computeAlignment(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- dispose(): void;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to create radio button controls
- */
- export class RadioButton extends Control {
- name?: string | undefined;
- private _isChecked;
- private _background;
- private _checkSizeRatio;
- private _thickness;
- /** Gets or sets border thickness */
- get thickness(): number;
- set thickness(value: number);
- /** Gets or sets group name */
- group: string;
- /** BABYLON.Observable raised when isChecked is changed */
- onIsCheckedChangedObservable: BABYLON.Observable<boolean>;
- /** Gets or sets a value indicating the ratio between overall size and check size */
- get checkSizeRatio(): number;
- set checkSizeRatio(value: number);
- /** Gets or sets background color */
- get background(): string;
- set background(value: string);
- /** Gets or sets a boolean indicating if the checkbox is checked or not */
- get isChecked(): boolean;
- set isChecked(value: boolean);
- /**
- * Creates a new RadioButton
- * @param name defines the control name
- */
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- _draw(context: CanvasRenderingContext2D): void;
- _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number): boolean;
- /**
- * Utility function to easily create a radio button with a header
- * @param title defines the label to use for the header
- * @param group defines the group to use for the radio button
- * @param isChecked defines the initial state of the radio button
- * @param onValueChanged defines the callback to call when value changes
- * @returns a StackPanel containing the radio button and a textBlock
- */
- static AddRadioButtonWithHeader(title: string, group: string, isChecked: boolean, onValueChanged: (button: RadioButton, value: boolean) => void): StackPanel;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to create slider controls
- */
- export class BaseSlider extends Control {
- name?: string | undefined;
- protected _thumbWidth: ValueAndUnit;
- private _minimum;
- private _maximum;
- private _value;
- private _isVertical;
- protected _barOffset: ValueAndUnit;
- private _isThumbClamped;
- protected _displayThumb: boolean;
- private _step;
- private _lastPointerDownID;
- protected _effectiveBarOffset: number;
- protected _renderLeft: number;
- protected _renderTop: number;
- protected _renderWidth: number;
- protected _renderHeight: number;
- protected _backgroundBoxLength: number;
- protected _backgroundBoxThickness: number;
- protected _effectiveThumbThickness: number;
- /** BABYLON.Observable raised when the sldier value changes */
- onValueChangedObservable: BABYLON.Observable<number>;
- /** Gets or sets a boolean indicating if the thumb must be rendered */
- get displayThumb(): boolean;
- set displayThumb(value: boolean);
- /** Gets or sets a step to apply to values (0 by default) */
- get step(): number;
- set step(value: number);
- /** Gets or sets main bar offset (ie. the margin applied to the value bar) */
- get barOffset(): string | number;
- /** Gets main bar offset in pixels*/
- get barOffsetInPixels(): number;
- set barOffset(value: string | number);
- /** Gets or sets thumb width */
- get thumbWidth(): string | number;
- /** Gets thumb width in pixels */
- get thumbWidthInPixels(): number;
- set thumbWidth(value: string | number);
- /** Gets or sets minimum value */
- get minimum(): number;
- set minimum(value: number);
- /** Gets or sets maximum value */
- get maximum(): number;
- set maximum(value: number);
- /** Gets or sets current value */
- get value(): number;
- set value(value: number);
- /**Gets or sets a boolean indicating if the slider should be vertical or horizontal */
- get isVertical(): boolean;
- set isVertical(value: boolean);
- /** Gets or sets a value indicating if the thumb can go over main bar extends */
- get isThumbClamped(): boolean;
- set isThumbClamped(value: boolean);
- /**
- * Creates a new BaseSlider
- * @param name defines the control name
- */
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- protected _getThumbPosition(): number;
- protected _getThumbThickness(type: string): number;
- protected _prepareRenderingData(type: string): void;
- private _pointerIsDown;
- /** @hidden */
- protected _updateValueFromPointer(x: number, y: number): void;
- _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number): boolean;
- _onPointerMove(target: Control, coordinates: BABYLON.Vector2, pointerId: number): void;
- _onPointerUp(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean): void;
- _onCanvasBlur(): void;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to create slider controls
- */
- export class Slider extends BaseSlider {
- name?: string | undefined;
- private _background;
- private _borderColor;
- private _thumbColor;
- private _isThumbCircle;
- protected _displayValueBar: boolean;
- /** Gets or sets a boolean indicating if the value bar must be rendered */
- get displayValueBar(): boolean;
- set displayValueBar(value: boolean);
- /** Gets or sets border color */
- get borderColor(): string;
- set borderColor(value: string);
- /** Gets or sets background color */
- get background(): string;
- set background(value: string);
- /** Gets or sets thumb's color */
- get thumbColor(): string;
- set thumbColor(value: string);
- /** Gets or sets a boolean indicating if the thumb should be round or square */
- get isThumbCircle(): boolean;
- set isThumbCircle(value: boolean);
- /**
- * Creates a new Slider
- * @param name defines the control name
- */
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: BABYLON.Nullable<Measure>): void;
- }
- }
- declare module BABYLON.GUI {
- /** Class used to create a RadioGroup
- * which contains groups of radio buttons
- */
- export class SelectorGroup {
- /** name of SelectorGroup */
- name: string;
- private _groupPanel;
- private _selectors;
- private _groupHeader;
- /**
- * Creates a new SelectorGroup
- * @param name of group, used as a group heading
- */
- constructor(
- /** name of SelectorGroup */
- name: string);
- /** Gets the groupPanel of the SelectorGroup */
- get groupPanel(): StackPanel;
- /** Gets the selectors array */
- get selectors(): StackPanel[];
- /** Gets and sets the group header */
- get header(): string;
- set header(label: string);
- /** @hidden */
- private _addGroupHeader;
- /** @hidden*/
- _getSelector(selectorNb: number): StackPanel | undefined;
- /** Removes the selector at the given position
- * @param selectorNb the position of the selector within the group
- */
- removeSelector(selectorNb: number): void;
- }
- /** Class used to create a CheckboxGroup
- * which contains groups of checkbox buttons
- */
- export class CheckboxGroup extends SelectorGroup {
- /** Adds a checkbox as a control
- * @param text is the label for the selector
- * @param func is the function called when the Selector is checked
- * @param checked is true when Selector is checked
- */
- addCheckbox(text: string, func?: (s: boolean) => void, checked?: boolean): void;
- /** @hidden */
- _setSelectorLabel(selectorNb: number, label: string): void;
- /** @hidden */
- _setSelectorLabelColor(selectorNb: number, color: string): void;
- /** @hidden */
- _setSelectorButtonColor(selectorNb: number, color: string): void;
- /** @hidden */
- _setSelectorButtonBackground(selectorNb: number, color: string): void;
- }
- /** Class used to create a RadioGroup
- * which contains groups of radio buttons
- */
- export class RadioGroup extends SelectorGroup {
- private _selectNb;
- /** Adds a radio button as a control
- * @param label is the label for the selector
- * @param func is the function called when the Selector is checked
- * @param checked is true when Selector is checked
- */
- addRadio(label: string, func?: (n: number) => void, checked?: boolean): void;
- /** @hidden */
- _setSelectorLabel(selectorNb: number, label: string): void;
- /** @hidden */
- _setSelectorLabelColor(selectorNb: number, color: string): void;
- /** @hidden */
- _setSelectorButtonColor(selectorNb: number, color: string): void;
- /** @hidden */
- _setSelectorButtonBackground(selectorNb: number, color: string): void;
- }
- /** Class used to create a SliderGroup
- * which contains groups of slider buttons
- */
- export class SliderGroup extends SelectorGroup {
- /**
- * Adds a slider to the SelectorGroup
- * @param label is the label for the SliderBar
- * @param func is the function called when the Slider moves
- * @param unit is a string describing the units used, eg degrees or metres
- * @param min is the minimum value for the Slider
- * @param max is the maximum value for the Slider
- * @param value is the start value for the Slider between min and max
- * @param onValueChange is the function used to format the value displayed, eg radians to degrees
- */
- addSlider(label: string, func?: (v: number) => void, unit?: string, min?: number, max?: number, value?: number, onValueChange?: (v: number) => number): void;
- /** @hidden */
- _setSelectorLabel(selectorNb: number, label: string): void;
- /** @hidden */
- _setSelectorLabelColor(selectorNb: number, color: string): void;
- /** @hidden */
- _setSelectorButtonColor(selectorNb: number, color: string): void;
- /** @hidden */
- _setSelectorButtonBackground(selectorNb: number, color: string): void;
- }
- /** Class used to hold the controls for the checkboxes, radio buttons and sliders
- * @see https://doc.babylonjs.com/how_to/selector
- */
- export class SelectionPanel extends Rectangle {
- /** name of SelectionPanel */
- name: string;
- /** an array of SelectionGroups */
- groups: SelectorGroup[];
- private _panel;
- private _buttonColor;
- private _buttonBackground;
- private _headerColor;
- private _barColor;
- private _barHeight;
- private _spacerHeight;
- private _labelColor;
- private _groups;
- private _bars;
- /**
- * Creates a new SelectionPanel
- * @param name of SelectionPanel
- * @param groups is an array of SelectionGroups
- */
- constructor(
- /** name of SelectionPanel */
- name: string,
- /** an array of SelectionGroups */
- groups?: SelectorGroup[]);
- protected _getTypeName(): string;
- /** Gets or sets the headerColor */
- get headerColor(): string;
- set headerColor(color: string);
- private _setHeaderColor;
- /** Gets or sets the button color */
- get buttonColor(): string;
- set buttonColor(color: string);
- private _setbuttonColor;
- /** Gets or sets the label color */
- get labelColor(): string;
- set labelColor(color: string);
- private _setLabelColor;
- /** Gets or sets the button background */
- get buttonBackground(): string;
- set buttonBackground(color: string);
- private _setButtonBackground;
- /** Gets or sets the color of separator bar */
- get barColor(): string;
- set barColor(color: string);
- private _setBarColor;
- /** Gets or sets the height of separator bar */
- get barHeight(): string;
- set barHeight(value: string);
- private _setBarHeight;
- /** Gets or sets the height of spacers*/
- get spacerHeight(): string;
- set spacerHeight(value: string);
- private _setSpacerHeight;
- /** Adds a bar between groups */
- private _addSpacer;
- /** Add a group to the selection panel
- * @param group is the selector group to add
- */
- addGroup(group: SelectorGroup): void;
- /** Remove the group from the given position
- * @param groupNb is the position of the group in the list
- */
- removeGroup(groupNb: number): void;
- /** Change a group header label
- * @param label is the new group header label
- * @param groupNb is the number of the group to relabel
- * */
- setHeaderName(label: string, groupNb: number): void;
- /** Change selector label to the one given
- * @param label is the new selector label
- * @param groupNb is the number of the groupcontaining the selector
- * @param selectorNb is the number of the selector within a group to relabel
- * */
- relabel(label: string, groupNb: number, selectorNb: number): void;
- /** For a given group position remove the selector at the given position
- * @param groupNb is the number of the group to remove the selector from
- * @param selectorNb is the number of the selector within the group
- */
- removeFromGroupSelector(groupNb: number, selectorNb: number): void;
- /** For a given group position of correct type add a checkbox button
- * @param groupNb is the number of the group to remove the selector from
- * @param label is the label for the selector
- * @param func is the function called when the Selector is checked
- * @param checked is true when Selector is checked
- */
- addToGroupCheckbox(groupNb: number, label: string, func?: () => void, checked?: boolean): void;
- /** For a given group position of correct type add a radio button
- * @param groupNb is the number of the group to remove the selector from
- * @param label is the label for the selector
- * @param func is the function called when the Selector is checked
- * @param checked is true when Selector is checked
- */
- addToGroupRadio(groupNb: number, label: string, func?: () => void, checked?: boolean): void;
- /**
- * For a given slider group add a slider
- * @param groupNb is the number of the group to add the slider to
- * @param label is the label for the Slider
- * @param func is the function called when the Slider moves
- * @param unit is a string describing the units used, eg degrees or metres
- * @param min is the minimum value for the Slider
- * @param max is the maximum value for the Slider
- * @param value is the start value for the Slider between min and max
- * @param onVal is the function used to format the value displayed, eg radians to degrees
- */
- addToGroupSlider(groupNb: number, label: string, func?: () => void, unit?: string, min?: number, max?: number, value?: number, onVal?: (v: number) => number): void;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to hold a the container for ScrollViewer
- * @hidden
- */
- export class _ScrollViewerWindow extends Container {
- parentClientWidth: number;
- parentClientHeight: number;
- private _freezeControls;
- private _parentMeasure;
- private _oldLeft;
- private _oldTop;
- get freezeControls(): boolean;
- set freezeControls(value: boolean);
- private _bucketWidth;
- private _bucketHeight;
- private _buckets;
- private _bucketLen;
- get bucketWidth(): number;
- get bucketHeight(): number;
- setBucketSizes(width: number, height: number): void;
- private _useBuckets;
- private _makeBuckets;
- private _dispatchInBuckets;
- private _updateMeasures;
- private _updateChildrenMeasures;
- private _restoreMeasures;
- /**
- * Creates a new ScrollViewerWindow
- * @param name of ScrollViewerWindow
- */
- constructor(name?: string);
- protected _getTypeName(): string;
- /** @hidden */
- protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- /** @hidden */
- _layout(parentMeasure: Measure, context: CanvasRenderingContext2D): boolean;
- private _scrollChildren;
- private _scrollChildrenWithBuckets;
- /** @hidden */
- _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: Measure): void;
- protected _postMeasure(): void;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to create slider controls
- */
- export class ScrollBar extends BaseSlider {
- name?: string | undefined;
- private _background;
- private _borderColor;
- private _tempMeasure;
- /** Gets or sets border color */
- get borderColor(): string;
- set borderColor(value: string);
- /** Gets or sets background color */
- get background(): string;
- set background(value: string);
- /**
- * Creates a new Slider
- * @param name defines the control name
- */
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- protected _getThumbThickness(): number;
- _draw(context: CanvasRenderingContext2D): void;
- private _first;
- private _originX;
- private _originY;
- /** @hidden */
- protected _updateValueFromPointer(x: number, y: number): void;
- _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number): boolean;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to create slider controls
- */
- export class ImageScrollBar extends BaseSlider {
- name?: string | undefined;
- private _backgroundBaseImage;
- private _backgroundImage;
- private _thumbImage;
- private _thumbBaseImage;
- private _thumbLength;
- private _thumbHeight;
- private _barImageHeight;
- private _tempMeasure;
- /** Number of 90° rotation to apply on the images when in vertical mode */
- num90RotationInVerticalMode: number;
- /**
- * Gets or sets the image used to render the background for horizontal bar
- */
- get backgroundImage(): Image;
- set backgroundImage(value: Image);
- /**
- * Gets or sets the image used to render the thumb
- */
- get thumbImage(): Image;
- set thumbImage(value: Image);
- /**
- * Gets or sets the length of the thumb
- */
- get thumbLength(): number;
- set thumbLength(value: number);
- /**
- * Gets or sets the height of the thumb
- */
- get thumbHeight(): number;
- set thumbHeight(value: number);
- /**
- * Gets or sets the height of the bar image
- */
- get barImageHeight(): number;
- set barImageHeight(value: number);
- /**
- * Creates a new ImageScrollBar
- * @param name defines the control name
- */
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- protected _getThumbThickness(): number;
- _draw(context: CanvasRenderingContext2D): void;
- private _first;
- private _originX;
- private _originY;
- /** @hidden */
- protected _updateValueFromPointer(x: number, y: number): void;
- _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number): boolean;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to hold a viewer window and sliders in a grid
- */
- export class ScrollViewer extends Rectangle {
- private _grid;
- private _horizontalBarSpace;
- private _verticalBarSpace;
- private _dragSpace;
- private _horizontalBar;
- private _verticalBar;
- private _barColor;
- private _barBackground;
- private _barImage;
- private _horizontalBarImage;
- private _verticalBarImage;
- private _barBackgroundImage;
- private _horizontalBarBackgroundImage;
- private _verticalBarBackgroundImage;
- private _barSize;
- private _window;
- private _pointerIsOver;
- private _wheelPrecision;
- private _onWheelObserver;
- private _clientWidth;
- private _clientHeight;
- private _useImageBar;
- private _thumbLength;
- private _thumbHeight;
- private _barImageHeight;
- private _horizontalBarImageHeight;
- private _verticalBarImageHeight;
- private _oldWindowContentsWidth;
- private _oldWindowContentsHeight;
- /**
- * Gets the horizontal scrollbar
- */
- get horizontalBar(): ScrollBar | ImageScrollBar;
- /**
- * Gets the vertical scrollbar
- */
- get verticalBar(): ScrollBar | ImageScrollBar;
- /**
- * Adds a new control to the current container
- * @param control defines the control to add
- * @returns the current container
- */
- addControl(control: BABYLON.Nullable<Control>): Container;
- /**
- * Removes a control from the current container
- * @param control defines the control to remove
- * @returns the current container
- */
- removeControl(control: Control): Container;
- /** Gets the list of children */
- get children(): Control[];
- _flagDescendantsAsMatrixDirty(): void;
- /**
- * Freezes or unfreezes the controls in the window.
- * When controls are frozen, the scroll viewer can render a lot more quickly but updates to positions/sizes of controls
- * are not taken into account. If you want to change positions/sizes, unfreeze, perform the changes then freeze again
- */
- get freezeControls(): boolean;
- set freezeControls(value: boolean);
- /** Gets the bucket width */
- get bucketWidth(): number;
- /** Gets the bucket height */
- get bucketHeight(): number;
- /**
- * Sets the bucket sizes.
- * When freezeControls is true, setting a non-zero bucket size will improve performances by updating only
- * controls that are visible. The bucket sizes is used to subdivide (internally) the window area to smaller areas into which
- * controls are dispatched. So, the size should be roughly equals to the mean size of all the controls of
- * the window. To disable the usage of buckets, sets either width or height (or both) to 0.
- * Please note that using this option will raise the memory usage (the higher the bucket sizes, the less memory
- * used), that's why it is not enabled by default.
- * @param width width of the bucket
- * @param height height of the bucket
- */
- setBucketSizes(width: number, height: number): void;
- private _forceHorizontalBar;
- private _forceVerticalBar;
- /**
- * Forces the horizontal scroll bar to be displayed
- */
- get forceHorizontalBar(): boolean;
- set forceHorizontalBar(value: boolean);
- /**
- * Forces the vertical scroll bar to be displayed
- */
- get forceVerticalBar(): boolean;
- set forceVerticalBar(value: boolean);
- /**
- * Creates a new ScrollViewer
- * @param name of ScrollViewer
- */
- constructor(name?: string, isImageBased?: boolean);
- /** Reset the scroll viewer window to initial size */
- resetWindow(): void;
- protected _getTypeName(): string;
- private _buildClientSizes;
- protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- protected _postMeasure(): void;
- /**
- * Gets or sets the mouse wheel precision
- * from 0 to 1 with a default value of 0.05
- * */
- get wheelPrecision(): number;
- set wheelPrecision(value: number);
- /** Gets or sets the scroll bar container background color */
- get scrollBackground(): string;
- set scrollBackground(color: string);
- /** Gets or sets the bar color */
- get barColor(): string;
- set barColor(color: string);
- /** Gets or sets the bar image */
- get thumbImage(): Image;
- set thumbImage(value: Image);
- /** Gets or sets the horizontal bar image */
- get horizontalThumbImage(): Image;
- set horizontalThumbImage(value: Image);
- /** Gets or sets the vertical bar image */
- get verticalThumbImage(): Image;
- set verticalThumbImage(value: Image);
- /** Gets or sets the size of the bar */
- get barSize(): number;
- set barSize(value: number);
- /** Gets or sets the length of the thumb */
- get thumbLength(): number;
- set thumbLength(value: number);
- /** Gets or sets the height of the thumb */
- get thumbHeight(): number;
- set thumbHeight(value: number);
- /** Gets or sets the height of the bar image */
- get barImageHeight(): number;
- set barImageHeight(value: number);
- /** Gets or sets the height of the horizontal bar image */
- get horizontalBarImageHeight(): number;
- set horizontalBarImageHeight(value: number);
- /** Gets or sets the height of the vertical bar image */
- get verticalBarImageHeight(): number;
- set verticalBarImageHeight(value: number);
- /** Gets or sets the bar background */
- get barBackground(): string;
- set barBackground(color: string);
- /** Gets or sets the bar background image */
- get barImage(): Image;
- set barImage(value: Image);
- /** Gets or sets the horizontal bar background image */
- get horizontalBarImage(): Image;
- set horizontalBarImage(value: Image);
- /** Gets or sets the vertical bar background image */
- get verticalBarImage(): Image;
- set verticalBarImage(value: Image);
- private _setWindowPosition;
- /** @hidden */
- private _updateScroller;
- _link(host: AdvancedDynamicTexture): void;
- /** @hidden */
- private _addBar;
- /** @hidden */
- private _attachWheel;
- _renderHighlightSpecific(context: CanvasRenderingContext2D): void;
- /** Releases associated resources */
- dispose(): void;
- }
- }
- declare module BABYLON.GUI {
- /** Class used to render a grid */
- export class DisplayGrid extends Control {
- name?: string | undefined;
- private _cellWidth;
- private _cellHeight;
- private _minorLineTickness;
- private _minorLineColor;
- private _majorLineTickness;
- private _majorLineColor;
- private _majorLineFrequency;
- private _background;
- private _displayMajorLines;
- private _displayMinorLines;
- /** Gets or sets a boolean indicating if minor lines must be rendered (true by default)) */
- get displayMinorLines(): boolean;
- set displayMinorLines(value: boolean);
- /** Gets or sets a boolean indicating if major lines must be rendered (true by default)) */
- get displayMajorLines(): boolean;
- set displayMajorLines(value: boolean);
- /** Gets or sets background color (Black by default) */
- get background(): string;
- set background(value: string);
- /** Gets or sets the width of each cell (20 by default) */
- get cellWidth(): number;
- set cellWidth(value: number);
- /** Gets or sets the height of each cell (20 by default) */
- get cellHeight(): number;
- set cellHeight(value: number);
- /** Gets or sets the tickness of minor lines (1 by default) */
- get minorLineTickness(): number;
- set minorLineTickness(value: number);
- /** Gets or sets the color of minor lines (DarkGray by default) */
- get minorLineColor(): string;
- set minorLineColor(value: string);
- /** Gets or sets the tickness of major lines (2 by default) */
- get majorLineTickness(): number;
- set majorLineTickness(value: number);
- /** Gets or sets the color of major lines (White by default) */
- get majorLineColor(): string;
- set majorLineColor(value: string);
- /** Gets or sets the frequency of major lines (default is 1 every 5 minor lines)*/
- get majorLineFrequency(): number;
- set majorLineFrequency(value: number);
- /**
- * Creates a new GridDisplayRectangle
- * @param name defines the control name
- */
- constructor(name?: string | undefined);
- _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: BABYLON.Nullable<Measure>): void;
- protected _getTypeName(): string;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to create slider controls based on images
- */
- export class ImageBasedSlider extends BaseSlider {
- name?: string | undefined;
- private _backgroundImage;
- private _thumbImage;
- private _valueBarImage;
- private _tempMeasure;
- get displayThumb(): boolean;
- set displayThumb(value: boolean);
- /**
- * Gets or sets the image used to render the background
- */
- get backgroundImage(): Image;
- set backgroundImage(value: Image);
- /**
- * Gets or sets the image used to render the value bar
- */
- get valueBarImage(): Image;
- set valueBarImage(value: Image);
- /**
- * Gets or sets the image used to render the thumb
- */
- get thumbImage(): Image;
- set thumbImage(value: Image);
- /**
- * Creates a new ImageBasedSlider
- * @param name defines the control name
- */
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: BABYLON.Nullable<Measure>): void;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Forcing an export so that this code will execute
- * @hidden
- */
- const name = "Statics";
- }
- declare module BABYLON.GUI {
- /**
- * This class can be used to get instrumentation data from a AdvancedDynamicTexture object
- */
- export class AdvancedDynamicTextureInstrumentation implements BABYLON.IDisposable {
- /**
- * Define the instrumented AdvancedDynamicTexture.
- */
- texture: AdvancedDynamicTexture;
- private _captureRenderTime;
- private _renderTime;
- private _captureLayoutTime;
- private _layoutTime;
- private _onBeginRenderObserver;
- private _onEndRenderObserver;
- private _onBeginLayoutObserver;
- private _onEndLayoutObserver;
- /**
- * Gets the perf counter used to capture render time
- */
- get renderTimeCounter(): BABYLON.PerfCounter;
- /**
- * Gets the perf counter used to capture layout time
- */
- get layoutTimeCounter(): BABYLON.PerfCounter;
- /**
- * Enable or disable the render time capture
- */
- get captureRenderTime(): boolean;
- set captureRenderTime(value: boolean);
- /**
- * Enable or disable the layout time capture
- */
- get captureLayoutTime(): boolean;
- set captureLayoutTime(value: boolean);
- /**
- * Instantiates a new advanced dynamic texture instrumentation.
- * This class can be used to get instrumentation data from an AdvancedDynamicTexture object
- * @param texture Defines the AdvancedDynamicTexture to instrument
- */
- constructor(
- /**
- * Define the instrumented AdvancedDynamicTexture.
- */
- texture: AdvancedDynamicTexture);
- /**
- * Dispose and release associated resources.
- */
- dispose(): void;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to load GUI via XML.
- */
- export class XmlLoader {
- private _nodes;
- private _nodeTypes;
- private _isLoaded;
- private _objectAttributes;
- private _parentClass;
- /**
- * Create a new xml loader
- * @param parentClass Sets the class context. Used when the loader is instanced inside a class and not in a global context
- */
- constructor(parentClass?: null);
- private _getChainElement;
- private _getClassAttribute;
- private _createGuiElement;
- private _parseGrid;
- private _parseElement;
- private _prepareSourceElement;
- private _parseElementsFromSource;
- private _parseXml;
- /**
- * Gets if the loading has finished.
- * @returns whether the loading has finished or not
- */
- isLoaded(): boolean;
- /**
- * Gets a loaded node / control by id.
- * @param id the Controls id set in the xml
- * @returns element of type Control
- */
- getNodeById(id: string): any;
- /**
- * Gets all loaded nodes / controls
- * @returns Array of controls
- */
- getNodes(): any;
- /**
- * Initiates the xml layout loading
- * @param xmlFile defines the xml layout to load
- * @param rootNode defines the node / control to use as a parent for the loaded layout controls.
- * @param callback defines the callback called on layout load.
- */
- loadLayout(xmlFile: any, rootNode: any, callback: any): void;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to create containers for controls
- */
- export class Container3D extends Control3D {
- private _blockLayout;
- /**
- * Gets the list of child controls
- */
- protected _children: Control3D[];
- /**
- * Gets the list of child controls
- */
- get children(): Array<Control3D>;
- /**
- * Gets or sets a boolean indicating if the layout must be blocked (default is false).
- * This is helpful to optimize layout operation when adding multiple children in a row
- */
- get blockLayout(): boolean;
- set blockLayout(value: boolean);
- /**
- * Creates a new container
- * @param name defines the container name
- */
- constructor(name?: string);
- /**
- * Force the container to update the layout. Please note that it will not take blockLayout property in account
- * @returns the current container
- */
- updateLayout(): Container3D;
- /**
- * Gets a boolean indicating if the given control is in the children of this control
- * @param control defines the control to check
- * @returns true if the control is in the child list
- */
- containsControl(control: Control3D): boolean;
- /**
- * Adds a control to the children of this control
- * @param control defines the control to add
- * @returns the current container
- */
- addControl(control: Control3D): Container3D;
- /**
- * This function will be called everytime a new control is added
- */
- protected _arrangeChildren(): void;
- protected _createNode(scene: BABYLON.Scene): BABYLON.Nullable<BABYLON.TransformNode>;
- /**
- * Removes a control from the children of this control
- * @param control defines the control to remove
- * @returns the current container
- */
- removeControl(control: Control3D): Container3D;
- protected _getTypeName(): string;
- /**
- * Releases all associated resources
- */
- dispose(): void;
- /** Control rotation will remain unchanged */
- static readonly UNSET_ORIENTATION: number;
- /** Control will rotate to make it look at sphere central axis */
- static readonly FACEORIGIN_ORIENTATION: number;
- /** Control will rotate to make it look back at sphere central axis */
- static readonly FACEORIGINREVERSED_ORIENTATION: number;
- /** Control will rotate to look at z axis (0, 0, 1) */
- static readonly FACEFORWARD_ORIENTATION: number;
- /** Control will rotate to look at negative z axis (0, 0, -1) */
- static readonly FACEFORWARDREVERSED_ORIENTATION: number;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to manage 3D user interface
- * @see https://doc.babylonjs.com/how_to/gui3d
- */
- export class GUI3DManager implements BABYLON.IDisposable {
- private _scene;
- private _sceneDisposeObserver;
- private _utilityLayer;
- private _rootContainer;
- private _pointerObserver;
- private _pointerOutObserver;
- /** @hidden */
- _lastPickedControl: Control3D;
- /** @hidden */
- _lastControlOver: {
- [pointerId: number]: Control3D;
- };
- /** @hidden */
- _lastControlDown: {
- [pointerId: number]: Control3D;
- };
- /**
- * BABYLON.Observable raised when the point picked by the pointer events changed
- */
- onPickedPointChangedObservable: BABYLON.Observable<BABYLON.Nullable<BABYLON.Vector3>>;
- /** @hidden */
- _sharedMaterials: {
- [key: string]: BABYLON.Material;
- };
- /** Gets the hosting scene */
- get scene(): BABYLON.Scene;
- /** Gets associated utility layer */
- get utilityLayer(): BABYLON.Nullable<BABYLON.UtilityLayerRenderer>;
- /**
- * Creates a new GUI3DManager
- * @param scene
- */
- constructor(scene?: BABYLON.Scene);
- private _handlePointerOut;
- private _doPicking;
- /**
- * Gets the root container
- */
- get rootContainer(): Container3D;
- /**
- * Gets a boolean indicating if the given control is in the root child list
- * @param control defines the control to check
- * @returns true if the control is in the root child list
- */
- containsControl(control: Control3D): boolean;
- /**
- * Adds a control to the root child list
- * @param control defines the control to add
- * @returns the current manager
- */
- addControl(control: Control3D): GUI3DManager;
- /**
- * Removes a control from the root child list
- * @param control defines the control to remove
- * @returns the current container
- */
- removeControl(control: Control3D): GUI3DManager;
- /**
- * Releases all associated resources
- */
- dispose(): void;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to transport BABYLON.Vector3 information for pointer events
- */
- export class Vector3WithInfo extends BABYLON.Vector3 {
- /** defines the current mouse button index */
- buttonIndex: number;
- /**
- * Creates a new Vector3WithInfo
- * @param source defines the vector3 data to transport
- * @param buttonIndex defines the current mouse button index
- */
- constructor(source: BABYLON.Vector3,
- /** defines the current mouse button index */
- buttonIndex?: number);
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used as base class for controls
- */
- export class Control3D implements BABYLON.IDisposable, BABYLON.IBehaviorAware<Control3D> {
- /** Defines the control name */
- name?: string | undefined;
- /** @hidden */
- _host: GUI3DManager;
- private _node;
- private _downCount;
- private _enterCount;
- private _downPointerIds;
- private _isVisible;
- /** Gets or sets the control position in world space */
- get position(): BABYLON.Vector3;
- set position(value: BABYLON.Vector3);
- /** Gets or sets the control scaling in world space */
- get scaling(): BABYLON.Vector3;
- set scaling(value: BABYLON.Vector3);
- /** Callback used to start pointer enter animation */
- pointerEnterAnimation: () => void;
- /** Callback used to start pointer out animation */
- pointerOutAnimation: () => void;
- /** Callback used to start pointer down animation */
- pointerDownAnimation: () => void;
- /** Callback used to start pointer up animation */
- pointerUpAnimation: () => void;
- /**
- * An event triggered when the pointer move over the control
- */
- onPointerMoveObservable: BABYLON.Observable<BABYLON.Vector3>;
- /**
- * An event triggered when the pointer move out of the control
- */
- onPointerOutObservable: BABYLON.Observable<Control3D>;
- /**
- * An event triggered when the pointer taps the control
- */
- onPointerDownObservable: BABYLON.Observable<Vector3WithInfo>;
- /**
- * An event triggered when pointer is up
- */
- onPointerUpObservable: BABYLON.Observable<Vector3WithInfo>;
- /**
- * An event triggered when a control is clicked on (with a mouse)
- */
- onPointerClickObservable: BABYLON.Observable<Vector3WithInfo>;
- /**
- * An event triggered when pointer enters the control
- */
- onPointerEnterObservable: BABYLON.Observable<Control3D>;
- /**
- * Gets or sets the parent container
- */
- parent: BABYLON.Nullable<Container3D>;
- private _behaviors;
- /**
- * Gets the list of attached behaviors
- * @see https://doc.babylonjs.com/features/behaviour
- */
- get behaviors(): BABYLON.Behavior<Control3D>[];
- /**
- * Attach a behavior to the control
- * @see https://doc.babylonjs.com/features/behaviour
- * @param behavior defines the behavior to attach
- * @returns the current control
- */
- addBehavior(behavior: BABYLON.Behavior<Control3D>): Control3D;
- /**
- * Remove an attached behavior
- * @see https://doc.babylonjs.com/features/behaviour
- * @param behavior defines the behavior to attach
- * @returns the current control
- */
- removeBehavior(behavior: BABYLON.Behavior<Control3D>): Control3D;
- /**
- * Gets an attached behavior by name
- * @param name defines the name of the behavior to look for
- * @see https://doc.babylonjs.com/features/behaviour
- * @returns null if behavior was not found else the requested behavior
- */
- getBehaviorByName(name: string): BABYLON.Nullable<BABYLON.Behavior<Control3D>>;
- /** Gets or sets a boolean indicating if the control is visible */
- get isVisible(): boolean;
- set isVisible(value: boolean);
- /**
- * Creates a new control
- * @param name defines the control name
- */
- constructor(
- /** Defines the control name */
- name?: string | undefined);
- /**
- * Gets a string representing the class name
- */
- get typeName(): string;
- /**
- * Get the current class name of the control.
- * @returns current class name
- */
- getClassName(): string;
- protected _getTypeName(): string;
- /**
- * Gets the transform node used by this control
- */
- get node(): BABYLON.Nullable<BABYLON.TransformNode>;
- /**
- * Gets the mesh used to render this control
- */
- get mesh(): BABYLON.Nullable<BABYLON.AbstractMesh>;
- /**
- * Link the control as child of the given node
- * @param node defines the node to link to. Use null to unlink the control
- * @returns the current control
- */
- linkToTransformNode(node: BABYLON.Nullable<BABYLON.TransformNode>): Control3D;
- /** @hidden **/
- _prepareNode(scene: BABYLON.Scene): void;
- /**
- * Node creation.
- * Can be overriden by children
- * @param scene defines the scene where the node must be attached
- * @returns the attached node or null if none. Must return a BABYLON.Mesh or BABYLON.AbstractMesh if there is an atttached visible object
- */
- protected _createNode(scene: BABYLON.Scene): BABYLON.Nullable<BABYLON.TransformNode>;
- /**
- * Affect a material to the given mesh
- * @param mesh defines the mesh which will represent the control
- */
- protected _affectMaterial(mesh: BABYLON.AbstractMesh): void;
- /** @hidden */
- _onPointerMove(target: Control3D, coordinates: BABYLON.Vector3): void;
- /** @hidden */
- _onPointerEnter(target: Control3D): boolean;
- /** @hidden */
- _onPointerOut(target: Control3D): void;
- /** @hidden */
- _onPointerDown(target: Control3D, coordinates: BABYLON.Vector3, pointerId: number, buttonIndex: number): boolean;
- /** @hidden */
- _onPointerUp(target: Control3D, coordinates: BABYLON.Vector3, pointerId: number, buttonIndex: number, notifyClick: boolean): void;
- /** @hidden */
- forcePointerUp(pointerId?: BABYLON.Nullable<number>): void;
- /** @hidden */
- _processObservables(type: number, pickedPoint: BABYLON.Vector3, pointerId: number, buttonIndex: number): boolean;
- /** @hidden */
- _disposeNode(): void;
- /**
- * Releases all associated resources
- */
- dispose(): void;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used as a root to all buttons
- */
- export class AbstractButton3D extends Control3D {
- /**
- * Creates a new button
- * @param name defines the control name
- */
- constructor(name?: string);
- protected _getTypeName(): string;
- protected _createNode(scene: BABYLON.Scene): BABYLON.TransformNode;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to create a button in 3D
- */
- export class Button3D extends AbstractButton3D {
- /** @hidden */
- protected _currentMaterial: BABYLON.Material;
- private _facadeTexture;
- private _content;
- private _contentResolution;
- private _contentScaleRatio;
- /**
- * Gets or sets the texture resolution used to render content (512 by default)
- */
- get contentResolution(): BABYLON.int;
- set contentResolution(value: BABYLON.int);
- /**
- * Gets or sets the texture scale ratio used to render content (2 by default)
- */
- get contentScaleRatio(): number;
- set contentScaleRatio(value: number);
- protected _disposeFacadeTexture(): void;
- protected _resetContent(): void;
- /**
- * Creates a new button
- * @param name defines the control name
- */
- constructor(name?: string);
- /**
- * Gets or sets the GUI 2D content used to display the button's facade
- */
- get content(): Control;
- set content(value: Control);
- /**
- * Apply the facade texture (created from the content property).
- * This function can be overloaded by child classes
- * @param facadeTexture defines the AdvancedDynamicTexture to use
- */
- protected _applyFacade(facadeTexture: AdvancedDynamicTexture): void;
- protected _getTypeName(): string;
- protected _createNode(scene: BABYLON.Scene): BABYLON.TransformNode;
- protected _affectMaterial(mesh: BABYLON.AbstractMesh): void;
- /**
- * Releases all associated resources
- */
- dispose(): void;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Abstract class used to create a container panel deployed on the surface of a volume
- */
- export abstract class VolumeBasedPanel extends Container3D {
- private _columns;
- private _rows;
- private _rowThenColum;
- private _orientation;
- protected _cellWidth: number;
- protected _cellHeight: number;
- /**
- * Gets or sets the distance between elements
- */
- margin: number;
- /**
- * Gets or sets the orientation to apply to all controls (BABYLON.Container3D.FaceOriginReversedOrientation by default)
- * | Value | Type | Description |
- * | ----- | ----------------------------------- | ----------- |
- * | 0 | UNSET_ORIENTATION | Control rotation will remain unchanged |
- * | 1 | FACEORIGIN_ORIENTATION | Control will rotate to make it look at sphere central axis |
- * | 2 | FACEORIGINREVERSED_ORIENTATION | Control will rotate to make it look back at sphere central axis |
- * | 3 | FACEFORWARD_ORIENTATION | Control will rotate to look at z axis (0, 0, 1) |
- * | 4 | FACEFORWARDREVERSED_ORIENTATION | Control will rotate to look at negative z axis (0, 0, -1) |
- */
- get orientation(): number;
- set orientation(value: number);
- /**
- * Gets or sets the number of columns requested (10 by default).
- * The panel will automatically compute the number of rows based on number of child controls.
- */
- get columns(): BABYLON.int;
- set columns(value: BABYLON.int);
- /**
- * Gets or sets a the number of rows requested.
- * The panel will automatically compute the number of columns based on number of child controls.
- */
- get rows(): BABYLON.int;
- set rows(value: BABYLON.int);
- /**
- * Creates new VolumeBasedPanel
- */
- constructor();
- protected _arrangeChildren(): void;
- /** Child classes must implement this function to provide correct control positioning */
- protected abstract _mapGridNode(control: Control3D, nodePosition: BABYLON.Vector3): void;
- /** Child classes can implement this function to provide additional processing */
- protected _finalProcessing(): void;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to create a container panel deployed on the surface of a cylinder
- */
- export class CylinderPanel extends VolumeBasedPanel {
- private _radius;
- /**
- * Gets or sets the radius of the cylinder where to project controls (5 by default)
- */
- get radius(): BABYLON.float;
- set radius(value: BABYLON.float);
- protected _mapGridNode(control: Control3D, nodePosition: BABYLON.Vector3): void;
- private _cylindricalMapping;
- }
- }
- declare module BABYLON.GUI {
- /** @hidden */
- export var fluentVertexShader: {
- name: string;
- shader: string;
- };
- }
- declare module BABYLON.GUI {
- /** @hidden */
- export var fluentPixelShader: {
- name: string;
- shader: string;
- };
- }
- declare module BABYLON.GUI {
- /** @hidden */
- export class FluentMaterialDefines extends BABYLON.MaterialDefines {
- INNERGLOW: boolean;
- BORDER: boolean;
- HOVERLIGHT: boolean;
- TEXTURE: boolean;
- constructor();
- }
- /**
- * Class used to render controls with fluent desgin
- */
- export class FluentMaterial extends BABYLON.PushMaterial {
- /**
- * Gets or sets inner glow intensity. A value of 0 means no glow (default is 0.5)
- */
- innerGlowColorIntensity: number;
- /**
- * Gets or sets the inner glow color (white by default)
- */
- innerGlowColor: BABYLON.Color3;
- /**
- * Gets or sets the albedo color (Default is BABYLON.Color3(0.3, 0.35, 0.4))
- */
- albedoColor: BABYLON.Color3;
- /**
- * Gets or sets a boolean indicating if borders must be rendered (default is false)
- */
- renderBorders: boolean;
- /**
- * Gets or sets border width (default is 0.5)
- */
- borderWidth: number;
- /**
- * Gets or sets a value indicating the smoothing value applied to border edges (0.02 by default)
- */
- edgeSmoothingValue: number;
- /**
- * Gets or sets the minimum value that can be applied to border width (default is 0.1)
- */
- borderMinValue: number;
- /**
- * Gets or sets a boolean indicating if hover light must be rendered (default is false)
- */
- renderHoverLight: boolean;
- /**
- * Gets or sets the radius used to render the hover light (default is 1.0)
- */
- hoverRadius: number;
- /**
- * Gets or sets the color used to render the hover light (default is BABYLON.Color4(0.3, 0.3, 0.3, 1.0))
- */
- hoverColor: BABYLON.Color4;
- /**
- * Gets or sets the hover light position in world space (default is BABYLON.Vector3.Zero())
- */
- hoverPosition: BABYLON.Vector3;
- private _albedoTexture;
- /** Gets or sets the texture to use for albedo color */
- albedoTexture: BABYLON.Nullable<BABYLON.BaseTexture>;
- /**
- * Creates a new Fluent material
- * @param name defines the name of the material
- * @param scene defines the hosting scene
- */
- constructor(name: string, scene: BABYLON.Scene);
- needAlphaBlending(): boolean;
- needAlphaTesting(): boolean;
- getAlphaTestTexture(): BABYLON.Nullable<BABYLON.BaseTexture>;
- isReadyForSubMesh(mesh: BABYLON.AbstractMesh, subMesh: BABYLON.SubMesh, useInstances?: boolean): boolean;
- bindForSubMesh(world: BABYLON.Matrix, mesh: BABYLON.Mesh, subMesh: BABYLON.SubMesh): void;
- getActiveTextures(): BABYLON.BaseTexture[];
- hasTexture(texture: BABYLON.BaseTexture): boolean;
- dispose(forceDisposeEffect?: boolean): void;
- clone(name: string): FluentMaterial;
- serialize(): any;
- getClassName(): string;
- static Parse(source: any, scene: BABYLON.Scene, rootUrl: string): FluentMaterial;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to create a holographic button in 3D
- */
- export class HolographicButton extends Button3D {
- private _backPlate;
- private _textPlate;
- private _frontPlate;
- private _text;
- private _imageUrl;
- private _shareMaterials;
- private _frontMaterial;
- private _backMaterial;
- private _plateMaterial;
- private _pickedPointObserver;
- private _tooltipFade;
- private _tooltipTextBlock;
- private _tooltipTexture;
- private _tooltipMesh;
- private _tooltipHoverObserver;
- private _tooltipOutObserver;
- private _disposeTooltip;
- /**
- * Rendering ground id of all the mesh in the button
- */
- set renderingGroupId(id: number);
- get renderingGroupId(): number;
- /**
- * Text to be displayed on the tooltip shown when hovering on the button. When set to null tooltip is disabled. (Default: null)
- */
- set tooltipText(text: BABYLON.Nullable<string>);
- get tooltipText(): BABYLON.Nullable<string>;
- /**
- * Gets or sets text for the button
- */
- get text(): string;
- set text(value: string);
- /**
- * Gets or sets the image url for the button
- */
- get imageUrl(): string;
- set imageUrl(value: string);
- /**
- * Gets the back material used by this button
- */
- get backMaterial(): FluentMaterial;
- /**
- * Gets the front material used by this button
- */
- get frontMaterial(): FluentMaterial;
- /**
- * Gets the plate material used by this button
- */
- get plateMaterial(): BABYLON.StandardMaterial;
- /**
- * Gets a boolean indicating if this button shares its material with other HolographicButtons
- */
- get shareMaterials(): boolean;
- /**
- * Creates a new button
- * @param name defines the control name
- */
- constructor(name?: string, shareMaterials?: boolean);
- protected _getTypeName(): string;
- private _rebuildContent;
- protected _createNode(scene: BABYLON.Scene): BABYLON.TransformNode;
- protected _applyFacade(facadeTexture: AdvancedDynamicTexture): void;
- private _createBackMaterial;
- private _createFrontMaterial;
- private _createPlateMaterial;
- protected _affectMaterial(mesh: BABYLON.Mesh): void;
- /**
- * Releases all associated resources
- */
- dispose(): void;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to create an interactable object. It's a 3D button using a mesh coming from the current scene
- */
- export class MeshButton3D extends Button3D {
- /** @hidden */
- protected _currentMesh: BABYLON.Mesh;
- /**
- * Creates a new 3D button based on a mesh
- * @param mesh mesh to become a 3D button
- * @param name defines the control name
- */
- constructor(mesh: BABYLON.Mesh, name?: string);
- protected _getTypeName(): string;
- protected _createNode(scene: BABYLON.Scene): BABYLON.TransformNode;
- protected _affectMaterial(mesh: BABYLON.AbstractMesh): void;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to create a container panel deployed on the surface of a plane
- */
- export class PlanePanel extends VolumeBasedPanel {
- protected _mapGridNode(control: Control3D, nodePosition: BABYLON.Vector3): void;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to create a container panel where items get randomized planar mapping
- */
- export class ScatterPanel extends VolumeBasedPanel {
- private _iteration;
- /**
- * Gets or sets the number of iteration to use to scatter the controls (100 by default)
- */
- get iteration(): BABYLON.float;
- set iteration(value: BABYLON.float);
- protected _mapGridNode(control: Control3D, nodePosition: BABYLON.Vector3): void;
- private _scatterMapping;
- protected _finalProcessing(): void;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to create a container panel deployed on the surface of a sphere
- */
- export class SpherePanel extends VolumeBasedPanel {
- private _radius;
- /**
- * Gets or sets the radius of the sphere where to project controls (5 by default)
- */
- get radius(): BABYLON.float;
- set radius(value: BABYLON.float);
- protected _mapGridNode(control: Control3D, nodePosition: BABYLON.Vector3): void;
- private _sphericalMapping;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to create a stack panel in 3D on XY plane
- */
- export class StackPanel3D extends Container3D {
- private _isVertical;
- /**
- * Gets or sets a boolean indicating if the stack panel is vertical or horizontal (horizontal by default)
- */
- get isVertical(): boolean;
- set isVertical(value: boolean);
- /**
- * Gets or sets the distance between elements
- */
- margin: number;
- /**
- * Creates new StackPanel
- * @param isVertical
- */
- constructor(isVertical?: boolean);
- protected _arrangeChildren(): void;
- }
- }
|